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

Fix some typos in archiving documentation.

Browse Source 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39054 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Alex Wilson
2010-10-23 01:51:37 +00:00
parent 04fc737059
commit a46d62a268
3 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/support/Archivable.dox
+1 -1
View File
@@ -119,7 +119,7 @@
\retval You should return a pointer to the object you create with \retval You should return a pointer to the object you create with
\c archive, or \c NULL if unarchival fails. \c archive, or \c NULL if unarchival fails.
\warning The default implementation will always return \c NULL. Even though \warning The default implementation will always return \c NULL. Even though
it is possible to store plain BArchive objects, it is impossible to it is possible to store plain BArchivable objects, it is impossible to
restore them. restore them.
\see instantiate_object(BMessage *from) \see instantiate_object(BMessage *from)
docs/user/support/Archiver.dox
+3 -1
View File
@@ -71,9 +71,11 @@
/*! /*!
\fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable, \fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable,
bool deep, int32& _token); bool deep, int32& _token);
\brief Get a token representing \c archivable for this archiving \brief Get a token representing a BArchivable object for this archiving
session. session.
\param archivable The BArchivable object for which you wish to get a
token.
\param deep Controls how \c archivable will be archived, if it has not yet \param deep Controls how \c archivable will be archived, if it has not yet
been archived in this session. been archived in this session.
\param[out] _token The token representing \c archivable is stored here. \param[out] _token The token representing \c archivable is stored here.
docs/user/support/Unarchiver.dox
+2 -2
View File
@@ -34,7 +34,7 @@
BUnarchiver helper classes, and want to maintain backwards compatibility BUnarchiver helper classes, and want to maintain backwards compatibility
with old archive, this can be done using the IsArchiveManaged() method. with old archive, this can be done using the IsArchiveManaged() method.
\Warning Calling methods on your BUnarchiver with a legacy archive (one that \warning Calling methods on your BUnarchiver with a legacy archive (one that
was not managed by a BArchiver during archival) will result in a was not managed by a BArchiver during archival) will result in a
call to debugger(). call to debugger().
*/ */
@@ -260,7 +260,7 @@ MyArchivableClas::MyArchivableClass(BMessage* archive)
It must be called once for each class an object inherits from that It must be called once for each class an object inherits from that
will use a BUnarchiver. will use a BUnarchiver.
\warning This method \bold must be called \bold before a call to the \warning This method \b must be called \b before a call to the
archive constructor of your parent class. archive constructor of your parent class.
Notice the use of this method in the example provided below. Notice the use of this method in the example provided below.