i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update the style of the Haiku Book to resemble the User Guide.

Browse Source 
If you have never seen this before you are in for a bit of a shock.
Update the Doxyfile to 1.7.3 (the version that gets auto-generated).

Update the book.dox front page with some nice introductory text.

Add new documentation for the following classes:
BCheckBox
BClipboard
BColorControl
BControl
BEntryList
BView (preliminary)

Remove redundant documentation from src/kits/storage/EntryList.cpp

Minor documentation update for the following classes:
BAlert
BApplication
BArchivable
BBox
BButton
BCatalog
BFindDirectory
BHandler
BUnarchiver
BString

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43096 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
John Scipione
2011-11-02 08:36:02 +00:00
parent 740ae7fef6
commit 6ac7032dc6
24 changed files with 4228 additions and 1369 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/support/Archivable.dox
+40 -18
View File
@@ -63,7 +63,8 @@
*/
/*! \fn BArchivable::BArchivable(BMessage* from)
/*!
\fn BArchivable::BArchivable(BMessage* from)
\brief Constructor. Does important behind-the-scenes work in the unarchiving
process.
@@ -74,17 +75,20 @@
*/
/*! \fn BArchivable::BArchivable()
/*!
\fn BArchivable::BArchivable()
\brief Constructor. Does nothing.
*/
/*! \fn BArchivable::~BArchivable()
/*!
\fn BArchivable::~BArchivable()
\brief Destructor. Does nothing.
*/
/*! \fn virtual status_t BArchivable::Archive(BMessage* into,
/*!
\fn virtual status_t BArchivable::Archive(BMessage* into,
bool deep = true) const
\brief Archive the object into a BMessage.
@@ -94,20 +98,23 @@
\param into The message you store your object in.
\param deep If \c true, all children of this object should be archived as
well.
\retval B_OK The archiving succeeded.
\retval "error codes" The archiving did not succeed.
\retval B_OK The archive operation was successful.
\retval B_BAD_VALUE \c NULL \a archive message.
\retval B_ERROR The archive operation failed.
*/
/*! \fn static BArchivable* BArchivable::Instantiate(BMessage* archive)
/*!
\fn static BArchivable* BArchivable::Instantiate(BMessage* archive)
\brief Static member to restore objects from messages.
You should always check that the \a archive argument actually corresponds to
your class. The automatic functions, such as #instantiate_object() and
BUnarchiver::InstantiateObject() will not choose the wrong class but manual
calls to this member might be faulty. You can verify that \c archive
stores an object of your calss with the validate_instantiation() function.
\param archive The message with the data of the object to restore.
\retval You should return a pointer to the object you create with
\c archive, or \c NULL if unarchival fails.
@@ -120,15 +127,24 @@
*/
/*! \fn virtual status_t BArchivable::Perform(perform_code d, void* arg)
\brief Internal method defined for binary compatibility purposes.
/*!
\fn virtual status_t BArchivable::Perform(perform_code d, void* arg)
\brief Perform some action (Internal method defined for binary
compatibility purposes).
\internal This method is defined for binary compatibility purposes, it is
used to ensure that the correct AllUnarchived() and AllArchived()
methods are called for objects, as those methods are new to Haiku.
\param d The perform code.
\param arg A pointer to store some data.
\returns A status code.
*/
/*! \fn virtual status_t BArchivable::AllUnarchived(const BMessage* archive)
/*!
\fn virtual status_t BArchivable::AllUnarchived(const BMessage* archive)
\brief Method relating to the use of \c BUnarchiver.
This hook function is called triggered in the BUnarchiver::Finish() method.
@@ -180,7 +196,8 @@
*/
/*! \fn BArchivable* instantiate_object(BMessage *from, image_id *id)
/*!
\fn BArchivable* instantiate_object(BMessage *from, image_id *id)
\brief Instantiate an archived object with the object being defined in a
different application or library.
@@ -194,7 +211,8 @@
*/
/*! \fn BArchivable* instantiate_object(BMessage *from)
/*!
\fn BArchivable* instantiate_object(BMessage *from)
\brief Instantiate an archived object.
This global function will determine the base class, based on the \a from
@@ -209,26 +227,30 @@
*/
/*! \fn bool validate_instantiation(BMessage* from, const char* className)
/*!
\fn bool validate_instantiation(BMessage* from, const char* className)
\brief Internal function that checks if the \a className is the same as the
one stored in the \a from message.
*/
/*! \fn instantiation_func find_instantiation_func(const char* className,
/*!
\fn instantiation_func find_instantiation_func(const char* className,
const char* signature)
\brief Internal function that searches for the instantiation func with a
specific signature. Use instantiate_object() instead.
*/
/*! \fn instantiation_func find_instantiation_func(const char* className)
/*!
\fn instantiation_func find_instantiation_func(const char* className)
\brief Internal function that searches for the instantiation func of a
specific class. Use instantiate_object() instead.
*/
/*! \fn instantiation_func find_instantiation_func(BMessage* archive)
/*!
\fn instantiation_func find_instantiation_func(BMessage* archive)
\brief Internal function that searches for the instantiation func that
works on the specified \a archive. Use instantiate_object() instead.
*/
docs/user/support/Unarchiver.dox
+41 -28
View File
@@ -11,7 +11,8 @@
*/
/*! \class BUnarchiver
/*!
\class BUnarchiver
\ingroup support
\ingroup libbe
\brief A class that simplifies the unarchiving of complicated BArchivable
@@ -39,7 +40,8 @@
*/
/*! \fn BUnarchiver::BUnarchiver(const BMessage* archive)
/*!
\fn BUnarchiver::BUnarchiver(const BMessage* archive)
\brief Constructs a BUnarchiver object to manage \c archive.
\note To guarantee that your AllUnarchived() method will be called during
@@ -55,14 +57,16 @@
*/
/*! \fn BUnarchiver::~BUnarchiver()
/*!
\fn BUnarchiver::~BUnarchiver()
\brief Destroys a BUnarchiver object.
Calls this objects Finish() method, if it has not yet been called.
*/
/*! \fn status_t BUnarchiver::EnsureUnarchived(int32 token)
/*!
\fn status_t BUnarchiver::EnsureUnarchived(int32 token)
\brief Ensure the object represented by \a token is unarchived and
instantiated.
@@ -70,7 +74,8 @@
*/
/*! \fn status_t BUnarchiver::EnsureUnarchived(const char* name,
/*!
\fn status_t BUnarchiver::EnsureUnarchived(const char* name,
int32 index = 0)
\brief Ensure the object archived under \a name at \a index is unarchived
and instantiated.
@@ -80,7 +85,8 @@
*/
/*! \fn bool BUnarchiver::IsInstantiated(int32 token)
/*!
\fn bool BUnarchiver::IsInstantiated(int32 token)
\brief Checks whether the object represented by \c token has been
instantiated in this session.
@@ -88,7 +94,8 @@
*/
/*! \fn bool BUnarchiver::IsInstantiated(const char* name, int32 index = 0)
/*!
\fn bool BUnarchiver::IsInstantiated(const char* name, int32 index = 0)
\brief Checks whether the object archived under \a name at \a index has been
instantiated in this session.
@@ -97,9 +104,9 @@
*/
/*! \fn template<class T> status_t BUnarchiver::GetObject(int32 token,
/*!
\fn template<class T> status_t BUnarchiver::GetObject(int32 token,
ownership_policy owning, T*& object)
\brief Recover an object by token that was archived by a BArchiver object.
If the object has not yet been instantiated, and this request is not coming
from an AllUnarchived() implementation, the object will be instantiated now.
@@ -121,9 +128,9 @@
*/
/*! \fn template<class T> status_t BUnarchiver::GetObject(int32 token,
/*!
\fn template<class T> status_t BUnarchiver::GetObject(int32 token,
T*& object)
\brief Recover and take ownership of an object represented by \a token.
Equivalent to calling GetObject(token, \c B_ASSUME_OWNERSHIP, object)
@@ -142,11 +149,12 @@
/*!
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
int32 index, ownership_policy owning, T*& object)
\brief Recover an object that had previously been archived using
the BArchiver::AddArchivable() method. If the object has not yet been
instantiated, and this request is not coming from an AllUnarchived()
implementation, the object will be instantiated now.
the BArchiver::AddArchivable() method.
If the object has not yet been instantiated, and this request is not
coming from an AllUnarchived() implementation, the object will be
instantiated now.
If the retrieved object is not of the type T, then this method will fail.
If this method fails, you will not receive ownership of the object, no
@@ -167,9 +175,9 @@
*/
/*! \fn template<class T> status_t BUnarchiver::FindObject(const char* name,
/*!
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
int32 index, T*& object)
\brief Recover and take ownership of an object that had previously been
archived using the BArchiver::AddArchivable() method.
@@ -186,9 +194,9 @@
*/
/*! \fn template<class T> status_t BUnarchiver::FindObject(const char* name,
/*!
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
ownership_policy owning, T*& object)
\brief Recover an object at index \c 0 that had previously been
archived using the BArchiver::AddArchivable() method.
@@ -207,9 +215,9 @@
*/
/*! \fn template<class T> status_t BUnarchiver::FindObject(const char* name,
/*!
\fn template<class T> status_t BUnarchiver::FindObject(const char* name,
T*& object)
\brief Recover and take ownership of an object at index \c 0 that had
previously been archived using the BArchiver::AddArchivable() method.
@@ -227,7 +235,8 @@
*/
/*! \fn status_t BUnarchiver::Finish(status_t err = B_OK);
/*!
\fn status_t BUnarchiver::Finish(status_t err = B_OK);
\brief Report any unarchiving errors and possibly complete the archiving
session.
@@ -260,8 +269,8 @@
*/
/*! \fn static bool BUnarchiver::IsArchiveManaged(const BMessage* archive)
/*!
\fn static bool BUnarchiver::IsArchiveManaged(const BMessage* archive)
\brief Checks whether \a archive was managed by a BArchiver object.
This method can be used to maintain archive backwards-compatibility for a
@@ -293,7 +302,8 @@ MyArchivableClas::MyArchivableClass(BMessage* archive)
*/
/*! \fn static BMessage* BUnarchiver::PrepareArchive(BMessage* &archive)
/*!
\fn static BMessage* BUnarchiver::PrepareArchive(BMessage* &archive)
\brief Prepares \c archive for use by a BUnarchiver.
This method must be called if you plan to use a BUnarchiver on an archive.
@@ -319,7 +329,8 @@ MyArchivableClas::MyArchivableClas(BMessage* archive)
*/
/*! \fn void BUnarchiver::AssumeOwnership(BArchivable* archivable)
/*!
\fn void BUnarchiver::AssumeOwnership(BArchivable* archivable)
\brief Become the owner of \a archivable.
After calling this method you are responsible for deleting the
@@ -329,7 +340,8 @@ MyArchivableClas::MyArchivableClas(BMessage* archive)
*/
/*! \fn void BUnarchiver::RelinquishOwnership(BArchivable* archivable)
/*!
\fn void BUnarchiver::RelinquishOwnership(BArchivable* archivable)
\brief Relinquish ownership of \a archivable. If \a archivable remains
unclaimed at the end of the unarchiving session, it will be deleted
(unless it is the root object).
@@ -338,7 +350,8 @@ MyArchivableClas::MyArchivableClas(BMessage* archive)
*/
/*! \fn template<class T> status_t BUnarchiver::InstantiateObject(
/*!
\fn template<class T> status_t BUnarchiver::InstantiateObject(
BMessage* from, T*& object)
\brief Attempt to instantiate an object of type T from BMessage*
\a from.
docs/user/support/string.dox
+4 -4
View File
@@ -1369,21 +1369,21 @@
*/
/*!
\fn BString& BString::ReplaceSet(const char *setOfChars, char with)
\fn BString& BString::ReplaceSet(const char *setOfBytes, char with)
\brief Replaces characters that are in a certain set with a chosen
character.
\param setOfChars The set of characters that need to be replaced.
\param setOfBytes The set of characters that need to be replaced.
\param with The character to replace the occurences with.
\return This method always returns \c *this.
*/
/*!
\fn BString& BString::ReplaceSet(const char *setOfChars, const char *with)
\fn BString& BString::ReplaceSet(const char *setOfBytes, const char *with)
\brief Replaces characters that are in a certain set with a chosen string.
\param setOfChars The set of characters that need to be replaced.
\param setOfBytes The set of characters that need to be replaced.
\param with The string to replace the occurences with.
\return This method always returns \c *this.