[haiku-commits] r39054 - haiku/trunk/docs/user/support

From: yourpalal2@xxxxxxxxx
To: haiku-commits@xxxxxxxxxxxxx
Date: Sat, 23 Oct 2010 03:51:38 +0200 (CEST)
Author: yourpalal
Date: 2010-10-23 03:51:37 +0200 (Sat, 23 Oct 2010)
New Revision: 39054
Changeset: http://dev.haiku-os.org/changeset/39054

Modified:
   haiku/trunk/docs/user/support/Archivable.dox
   haiku/trunk/docs/user/support/Archiver.dox
   haiku/trunk/docs/user/support/Unarchiver.dox
Log:
Fix some typos in archiving documentation.


Modified: haiku/trunk/docs/user/support/Archivable.dox
===================================================================
--- haiku/trunk/docs/user/support/Archivable.dox        2010-10-22 21:09:10 UTC 
(rev 39053)
+++ haiku/trunk/docs/user/support/Archivable.dox        2010-10-23 01:51:37 UTC 
(rev 39054)
@@ -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)

Modified: haiku/trunk/docs/user/support/Archiver.dox
===================================================================
--- haiku/trunk/docs/user/support/Archiver.dox  2010-10-22 21:09:10 UTC (rev 
39053)
+++ haiku/trunk/docs/user/support/Archiver.dox  2010-10-23 01:51:37 UTC (rev 
39054)
@@ -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.

Modified: haiku/trunk/docs/user/support/Unarchiver.dox
===================================================================
--- haiku/trunk/docs/user/support/Unarchiver.dox        2010-10-22 21:09:10 UTC 
(rev 39053)
+++ haiku/trunk/docs/user/support/Unarchiver.dox        2010-10-23 01:51:37 UTC 
(rev 39054)
@@ -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 @@
        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.
[haiku-commits] r39054 - haiku/trunk/docs/user/support

Other related posts:
