diff --git a/src/documentation/haiku_book/howto.xml b/src/documentation/haiku_book/howto.xml index 3a814560d6..a8a8474202 100644 --- a/src/documentation/haiku_book/howto.xml +++ b/src/documentation/haiku_book/howto.xml @@ -26,7 +26,7 @@ 1 - 2005-10-26 + 2005-12-23 nielx First section about documenting classes on review. @@ -236,9 +236,10 @@ We can distinguish roughly three parts. First of all, we've got the class summary. This includes a formal block with useful information. Secondly, - we document the constructors and destructors. Then we describe + we document the constructors and destructors. Thirdly, we describe the static + members that the class might have. Then we describe the member functions. Finally we describe the operators that are overloaded. - Note that any section can be left out if it's not available. For example, the + Note that any section can be left out if it's not applicable. For example, the BList class doesn't have actual overloaded operators, thus that section is not in the actual documentation. The following example gives a rough outline of the BList documentation. @@ -260,6 +261,10 @@ ... constructors come here ... +<bridgehead renderas="sect2">Static Functions</bridgehead> + +... member functions come here ... + <bridgehead renderas="sect2">Member Functions</bridgehead> ... member functions come here ... @@ -415,13 +420,15 @@ - Member documentation + Static and Member documentation - The member documentation starts under the second + Static documentation starts under the second <bridgehead> with the label - Member Functions. This <bridgehead> - has the same properties as the one the one used with the constructors. + Static Functions. The member functions start under + Member Functions. These <bridgehead> + have the same properties as the one the one used with the constructors. + Note that either section can be left out if they are not applicable. @@ -699,8 +706,12 @@ The last thing you need to be aware of is whether or not the method is - modified by a trailing const. If so, you need to append - <modifier>const</modifier>. The location + modified by a trailing const, or if the method is a pure + virtual. If so, you need to append either + <modifier>const</modifier> or + <modifier>= 0</modifier>. Please note the + space between the = and the 0 in the + syntax for the pure virtuals. The location of this modifier depends on whether or not the method has arguments. If it doesn't have any arguments, just append it to the single line you've written. If there are arguments, put this on a newline after the last argument. diff --git a/src/documentation/haiku_book/support/Archivable.xml b/src/documentation/haiku_book/support/Archivable.xml new file mode 100644 index 0000000000..17d8bc8d26 --- /dev/null +++ b/src/documentation/haiku_book/support/Archivable.xml @@ -0,0 +1,60 @@ + + + + BArchivable + + + Derived from: none + Declared in: os/support/Archivable.h + Library: libbe.so + + + BArchivable works on archiving and unarchiving BMessages. + + Constructors and Destructors + + BArchivable() + + + BArchivable + + + + BArchivable + BMessage *from + + + + + ~BArchivable() + + + ~BArchivable + + + + Static Functions + + Instantiate() + + + staticBArchivable *Instatiate + BMessage *from + + + + Member Functions + + Archive() + + + virtualstatus_tArchive + BMessage *into + booldeeptrue + const + + + + + + diff --git a/src/documentation/haiku_book/support/Flattenable.xml b/src/documentation/haiku_book/support/Flattenable.xml new file mode 100644 index 0000000000..2c9b258e5c --- /dev/null +++ b/src/documentation/haiku_book/support/Flattenable.xml @@ -0,0 +1,82 @@ + + + + BFlattenable + + + Derived from: none + Declared in: os/support/Flattenable.h + Library: libbe.so + + + BFlattenable is a protocol that classes can implement so that they can be written to a stream of bytes. + + Constructors and Destructors + + ~BFlattenable + + + virtual~BFlattenable + + + + Member Functions + + AllowsTypeCode() + + + virtualboolAllowsTypeCode + type_codecode + = 0 + + + + + Flatten() + + + virtualstatus_tFlatten + void *buffer + ssize_tsize + const= 0 + + + + + FlattenedSize() + + + virtualssize_tFlattenedSizeconst= 0 + + + + + IsFixedSize() + + + virtualboolIsFixedSizeconst= 0 + + + + + TypeCode() + + + virtualtype_codeTypeCodeconst= 0 + + + + + Unflatten + + + virtualstatus_tUnflatten + type_codec + constvoid *buf + ssize_tsize + = 0 + + + + + diff --git a/src/documentation/haiku_book/support/String.xml b/src/documentation/haiku_book/support/String.xml index 772e8c15c3..5d7ea8c65f 100644 --- a/src/documentation/haiku_book/support/String.xml +++ b/src/documentation/haiku_book/support/String.xml @@ -92,6 +92,36 @@ + + Compare() + + + intCompare + constBString &string + const + + + + intCompare + constchar *string + const + + + + intCompare + constBString &string + int32n + const + + + + intCompare + constchar *string + int32n + const + + + CopyInto() @@ -118,6 +148,36 @@ + + ICompare() + + + intICompare + constBString &string + const + + + + intICompare + constchar *string + const + + + + intICompare + constBString &string + int32n + const + + + + intICompare + constchar *string + int32n + const + + + Insert() @@ -379,4 +439,79 @@ + + <, <=, ==, >, >=, != (comparison) + + + BString &operator< + constBString &string + const + + + + BString &operator< + constchar *string + const + + + + BString &operator<= + constBString &string + const + + + + BString &operator<= + constchar *string + const + + + + BString &operator== + constBString &string + const + + + + BString &operator== + constchar *string + const + + + + BString &operator>= + constBString &string + const + + + + BString &operator>= + constchar *string + const + + + + BString &operator> + constBString &string + const + + + + BString &operator> + constchar *string + const + + + + BString &operator!= + constBString &string + const + + + + BString &operator!= + constchar *string + const + + diff --git a/src/documentation/haiku_book/support/api.xml b/src/documentation/haiku_book/support/api.xml index 3e48eedbb2..34b0d722e4 100644 --- a/src/documentation/haiku_book/support/api.xml +++ b/src/documentation/haiku_book/support/api.xml @@ -2,8 +2,10 @@ + @@ -13,8 +15,10 @@ Support Kit API + &archivable; &autolock; &blockcache; + &flattenable; &list; &locker; &string; diff --git a/src/documentation/haiku_book/support/intro.xml b/src/documentation/haiku_book/support/intro.xml index 5fa97e3d11..f9cc7ea53b 100644 --- a/src/documentation/haiku_book/support/intro.xml +++ b/src/documentation/haiku_book/support/intro.xml @@ -20,8 +20,8 @@ Archiving and IO: - BArchivable - BFlattenable + BArchivable + BFlattenable BDataIO and BPositionIO BMemoryIO and BMallocIO