From a46d62a268ff19dfd3f6b867ab7b049d953d3fb3 Mon Sep 17 00:00:00 2001 From: Alex Wilson Date: Sat, 23 Oct 2010 01:51:37 +0000 Subject: [PATCH] Fix some typos in archiving documentation. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39054 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- docs/user/support/Archivable.dox | 2 +- docs/user/support/Archiver.dox | 4 +++- docs/user/support/Unarchiver.dox | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/user/support/Archivable.dox b/docs/user/support/Archivable.dox index 3d01933b42..f2b01a76d0 100644 --- a/docs/user/support/Archivable.dox +++ b/docs/user/support/Archivable.dox @@ -119,7 +119,7 @@ \retval You should return a pointer to the object you create with \c archive, or \c NULL if unarchival fails. \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. \see instantiate_object(BMessage *from) diff --git a/docs/user/support/Archiver.dox b/docs/user/support/Archiver.dox index c590594523..a3a8fd334a 100644 --- a/docs/user/support/Archiver.dox +++ b/docs/user/support/Archiver.dox @@ -71,9 +71,11 @@ /*! \fn status_t BArchiver::GetTokenForArchivable(BArchivable* archivable, 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. + \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 been archived in this session. \param[out] _token The token representing \c archivable is stored here. diff --git a/docs/user/support/Unarchiver.dox b/docs/user/support/Unarchiver.dox index 399982d20a..de6b6b26d7 100644 --- a/docs/user/support/Unarchiver.dox +++ b/docs/user/support/Unarchiver.dox @@ -34,7 +34,7 @@ BUnarchiver helper classes, and want to maintain backwards compatibility 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 call to debugger(). */ @@ -260,7 +260,7 @@ MyArchivableClas::MyArchivableClass(BMessage* archive) It must be called once for each class an object inherits from that 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. Notice the use of this method in the example provided below.