From a72f3582be00f2151800fa7da036d7adc14e3272 Mon Sep 17 00:00:00 2001
From: Niels Sascha Reedijk <niels.reedijk@gmail.com>
Date: Sun, 1 Sep 2019 16:09:54 +0100
Subject: [PATCH] API Docs: Add placeholder for Key.h, KeyStore.h and
 Notification.h

---
 docs/user/app/Key.dox          | 422 +++++++++++++++++++++++++++++++++
 docs/user/app/KeyStore.dox     | 390 ++++++++++++++++++++++++++++++
 docs/user/app/Notification.dox | 330 ++++++++++++++++++++++++++
 3 files changed, 1142 insertions(+)
 create mode 100644 docs/user/app/Key.dox
 create mode 100644 docs/user/app/KeyStore.dox
 create mode 100644 docs/user/app/Notification.dox

diff --git a/docs/user/app/Key.dox b/docs/user/app/Key.dox
new file mode 100644
index 0000000000..46a7ea56fa
--- /dev/null
+++ b/docs/user/app/Key.dox
@@ -0,0 +1,422 @@
+/*
+ * Copyright 2019 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ *		Niels Sascha Reedijk, niels.reedijk@gmail.com
+ *
+ * Corresponds to:
+ *		headers/os/app/Key.h	hrev45343
+ *		src/kits/app/Key.cpp	hrev45343
+ */
+
+
+ /*!
+	\file Key.h
+	\ingroup app
+	\ingroup libbe
+	\brief Provides BKey and BPasswordKey classes, as well as BKeyPurpose and
+        BKeyType enums.
+*/
+
+
+ ///// BKeyPurpose enum /////
+
+
+/*!
+    \enum BKeyPurpose
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyPurpose::B_KEY_PURPOSE_ANY
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyPurpose::B_KEY_PURPOSE_GENERIC
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyPurpose::B_KEY_PURPOSE_KEYRING
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyPurpose::B_KEY_PURPOSE_WEB
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyPurpose::B_KEY_PURPOSE_NETWORK
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyPurpose::B_KEY_PURPOSE_VOLUME
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+ ///// BKeyType enum /////
+
+
+/*!
+    \enum BKeyType
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyType::B_KEY_TYPE_ANY
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyType::B_KEY_TYPE_GENERIC
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyType::B_KEY_TYPE_PASSWORD
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \var BKeyType::B_KEY_TYPE_CERTIFICATE
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+///// BKey class /////
+
+
+/*!
+    \class BKey
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BKey::BKey();
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BKey::BKey(BKeyPurpose purpose, const char* identifier, 
+        const char* secondaryIdentifier = NULL, const uint8* data = NULL,
+		size_t length = 0)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BKey::BKey(BKey& other)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual BKey::~BKey()
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual	BKeyType BKey::Type() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BKey::Unset()
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKey::SetTo(BKeyPurpose purpose, const char* identifier,
+		const char* secondaryIdentifier = NULL, const uint8* data = NULL,
+		size_t length = 0)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BKey::SetPurpose(BKeyPurpose purpose)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BKeyPurpose BKey::Purpose() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BKey::SetIdentifier(const char* identifier)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BKey::Identifier() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BKey::SetSecondaryIdentifier(const char* identifier)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BKey::SecondaryIdentifier() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKey::SetData(const uint8* data, size_t length)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn size_t BKey::DataLength() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const uint8* BKey::Data() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKey::GetData(uint8* buffer, size_t bufferSize) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BKey::Owner() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn bigtime_t BKey::CreationTime() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual status_t BKey::Flatten(BMessage& message) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual status_t BKey::Unflatten(const BMessage& message)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BKey& BKey::operator=(const BKey& other)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn bool BKey::operator==(const BKey& other) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn bool BKey::operator!=(const BKey& other) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual void BKey::PrintToStream();
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+///// BPasswordKey class /////
+
+
+
+/*!
+    \class BPasswordKey
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+/*!
+	\fn BPasswordKey::BPasswordKey()
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BPasswordKey::BPasswordKey(const char* password, BKeyPurpose purpose,
+        const char* identifier, const char* secondaryIdentifier = NULL)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BPasswordKey::BPasswordKey(BPasswordKey& other)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual BPasswordKey::~BPasswordKey()
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual BKeyType BPasswordKey::Type() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BPasswordKey::SetTo(const char* password, BKeyPurpose purpose,
+		const char* identifier, const char* secondaryIdentifier = NULL)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BPasswordKey::SetPassword(const char* password)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BPasswordKey::Password() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual void BPasswordKey::PrintToStream()
+    \brief Undocumented
+
+    \since Haiku R1
+*/
diff --git a/docs/user/app/KeyStore.dox b/docs/user/app/KeyStore.dox
new file mode 100644
index 0000000000..288d3f5075
--- /dev/null
+++ b/docs/user/app/KeyStore.dox
@@ -0,0 +1,390 @@
+/*
+ * Copyright 2019 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ *		Niels Sascha Reedijk, niels.reedijk@gmail.com
+ *
+ * Corresponds to:
+ *		headers/os/app/KeyStore.h	hrev45434
+ *		src/kits/app/KeyStore.cpp	hrev45434
+ */
+
+
+ /*!
+	\file KeyStore.h
+	\ingroup app
+	\ingroup libbe
+	\brief Provides BKeyStore class.
+*/
+
+
+/*!
+	\class BKeyStore
+	\ingroup app
+	\ingroup libbe
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \fn BKeyStore::BKeyStore()
+    \brief undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+    \fn virtual BKeyStore::~BKeyStore()
+    \brief undocumented
+
+    \since Haiku R1
+*/
+
+/*!
+	\name Key Management
+*/
+
+
+//! @{
+
+
+/*!
+    \fn status_t BKeyStore::GetKey(BKeyType type, const char* identifier,
+		BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetKey(BKeyType type, const char* identifier,
+		const char* secondaryIdentifier, BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetKey(BKeyType type, const char* identifier,
+		const char* secondaryIdentifier, bool secondaryIdentifierOptional,
+		BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetKey(const char* keyring, BKeyType type,
+        const char* identifier, BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetKey(const char* keyring, BKeyType type,
+        const char* identifier, const char* secondaryIdentifier, BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetKey(const char* keyring, BKeyType type,
+        const char* identifier, const char* secondaryIdentifier,
+		bool secondaryIdentifierOptional, BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::AddKey(const BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::AddKey(const char* keyring, const BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::RemoveKey(const BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::RemoveKey(const char* keyring, const BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetNextKey(uint32& cookie, BKey& key);
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetNextKey(BKeyType type, BKeyPurpose purpose,
+		uint32& cookie, BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetNextKey(const char* keyring, uint32& cookie,
+        BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetNextKey(const char* keyring, BKeyType type,
+        BKeyPurpose purpose, uint32& cookie, BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+//! @}
+
+
+/*!
+	\name Keyrings
+*/
+
+
+//! @{
+
+
+/*!
+	\fn status_t BKeyStore::AddKeyring(const char* keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::RemoveKeyring(const char* keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetNextKeyring(uint32& cookie, BString& keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::SetUnlockKey(const char* keyring, const BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::RemoveUnlockKey(const char* keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+//! @}
+
+
+/*!
+	\name Master keyring
+*/
+
+
+//! @{
+
+
+/*!
+	\fn status_t BKeyStore::SetMasterUnlockKey(const BKey& key)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::RemoveMasterUnlockKey()
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::AddKeyringToMaster(const char* keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::RemoveKeyringFromMaster(const char* keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetNextMasterKeyring(uint32& cookie,
+        BString& keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+//! @}
+
+
+/*!
+	\name Locking
+*/
+
+
+//! @{
+
+
+/*!
+	\fn bool BKeyStore::IsKeyringUnlocked(const char* keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::LockKeyring(const char* keyring)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::LockMasterKeyring() 
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+//! @}
+
+
+/*!
+	\name Applications
+*/
+
+
+//! @{
+
+
+/*!
+	\fn status_t BKeyStore::GetNextApplication(uint32& cookie,
+		BString& signature) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::GetNextApplication(const char* keyring,
+		uint32& cookie, BString& signature) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::RemoveApplication(const char* signature)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BKeyStore::RemoveApplication(const char* keyring,
+		const char* signature)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+//! @}
+
+
+/*!
+	\name Service Functions
+*/
+
+
+//! @{
+
+
+/*!
+	\fn status_t BKeyStore::GeneratePassword(BPasswordKey& password,
+		size_t length, uint32 flags)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn float BKeyStore::PasswordStrength(const char* password)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+//! @}
diff --git a/docs/user/app/Notification.dox b/docs/user/app/Notification.dox
new file mode 100644
index 0000000000..e57f807786
--- /dev/null
+++ b/docs/user/app/Notification.dox
@@ -0,0 +1,330 @@
+/*
+ * Copyright 2019 Haiku, Inc. All rights reserved.
+ * Distributed under the terms of the MIT License.
+ *
+ * Authors:
+ *		Niels Sascha Reedijk, niels.reedijk@gmail.com
+ *
+ * Corresponds to:
+ *		headers/os/app/Notification.h	hrev51445
+ *		src/kits/app/Notification.cpp	hrev52287
+ */
+
+
+ /*!
+	\file Notification.h
+	\ingroup app
+	\ingroup libbe
+	\brief Provides BNotification class and the notification_type enum.
+*/
+
+
+///// notification_type enum /////
+
+
+/*!
+    \enum notification_type
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\var notification_type::B_INFORMATION_NOTIFICATION
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\var notification_type::B_IMPORTANT_NOTIFICATION
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\var notification_type::B_ERROR_NOTIFICATION
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\var notification_type::B_PROGRESS_NOTIFICATION
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+///// BNotification class /////
+
+
+/*!
+    \class BNotification
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BNotification::BNotification(notification_type type)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn BNotification::BNotification(BMessage* archive)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual BNotification::~BNotification()
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BNotification::InitCheck() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn static BArchivable* BNotification::Instantiate(BMessage* archive)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn virtual status_t BNotification::Archive(BMessage* archive,
+        bool deep = true) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BNotification::SourceSignature() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BNotification::SourceName() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn notification_type BNotification::Type() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BNotification::Group() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BNotification::SetGroup(const BString& group)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BNotification::Title() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BNotification::SetTitle(const BString& title)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BNotification::Content() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BNotification::SetContent(const BString& content)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BNotification::MessageID() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BNotification::SetMessageID(const BString& id)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn float BNotification::Progress() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BNotification::SetProgress(float progress)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BNotification::OnClickApp() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn void BNotification::SetOnClickApp(const BString& app)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const entry_ref* BNotification::OnClickFile() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BNotification::SetOnClickFile(const entry_ref* file)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BNotification::AddOnClickRef(const entry_ref* ref)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn int32 BNotification::CountOnClickRefs() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const entry_ref* BNotification::OnClickRefAt(int32 index) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BNotification::AddOnClickArg(const BString& arg)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn int32 BNotification::CountOnClickArgs() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const char* BNotification::OnClickArgAt(int32 index) const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn const BBitmap* BNotification::Icon() const
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BNotification::SetIcon(const BBitmap* icon)
+    \brief Undocumented
+
+    \since Haiku R1
+*/
+
+
+/*!
+	\fn status_t BNotification::Send(bigtime_t timeout = -1)
+    \brief Undocumented
+
+    \since Haiku R1
+*/