Initial revision of the API documentation guidelines up for discussion. DataIO.dox and List.dox conform to these guidelines.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20392 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-03-19 09:38:47 +00:00
parent 18108ef7de
commit a38ee20f99
4 changed files with 1159 additions and 433 deletions
@@ -1022,9 +1022,12 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator 
 # instead of the = operator.
-# Beep.h requires __cplusplus to be defined.
+# Beep.h and SupportDefs.h require __cplusplus to be defined.
 # SupportDefs.h defines some things that are also defined in types.h. There's
 #   check whether or not types.h has already been included. There is no need
 #   to put these definitions in our docs.
-PREDEFINED             = __cplusplus
+PREDEFINED             = __cplusplus _SYS_TYPES_H
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
 # this tag can be used to specify a list of macro names that should be expanded. 
@@ -0,0 +1,686 @@
 // 
 // Copyright 2007, Haiku Inc. All Rights Reserved.
 //
 // Distributed under the terms of the MIT License.
 //
 //
 // Documentation by: 
 //   Niels Sascha Reedijk <[email protected]>
 //
 /*!
  \page apidoc Documenting the API
  This article explains how to document the API. It's intended audience are the
  Haiku developers that want to document their own classes, and also the
  members of the API Documentation team who want to brush up the documentation.
  This document is divided into three sections. \ref formalrequirements
  describes the demands that are made from the markup and
  spacing of the files. \ref commands describes the subset
  of Doxygen commands the Haiku API documentation uses, and which commands
  are used in which situation. \ref style describes the
  writing style that is required. The demands are both on the required sections
  in the documentation as well as on the wording of that documentation.
  If you are a developer and you want to prepare the first version of the
  documentation for the API documentation team to go over, have a good look
  at the formal requirements and the doxygen commands, and have a quick glance
  at how to write member and class documentation, since you'll need to know
  which information should definately be in the documentation. Aspiring members
  or members of the API documentation team should read the third section
  carefully, and should also check out some of the finished documentation to
  get a good grip on the actual tone, style and contents of the documentation.
  \section formalrequirements Formal Requirements
  This section describes formal requirements, such as location and naming of
  the files, the header blocks of files, what blocks of documentation look like
  and how to put delimeters to separate different 'blocks' in your source file.
  \subsection formalrequirements_location Location of the Documentation Source
  Doxygen, the tool that we use to generate the marked up documentation with,
  has an ingenious parser that is able to scan through both header and source
  files and that makes it possible to document the API directly in the headers
  or the source. However, the Haiku project decided not to put the
  documentation in either location, and opt for the third option Doxygen gives:
  to put the documentation in separate files. 
  \note The reasons to not put the
    documentation in the header files are twofold. First of all, it would
    unnecesarily add much cruft to the headers that the compiler will have to
    parse unneededly. File access and speed isn't BeOS and Haiku's best quality.
    The second reason is that the system headers are included throughout the
    tree. It's a waste of electricity to have everybody recompile the entire tree
    if someone fixes a typo in the documentation. Likewise, the reason to not put
    the documentation in the source is that it unnecesarily clutters up that
    source. By not using direct documentation we lose some advantages, like the
    fact that developers might be inclined to update the documentation quicker
    if they change a method, but as you will see we'll have some methods in place
    to prevent that to a certain extend.
  There are a few aspects to naming and location of files:
  -# Most important, documentation files \b mirror header files. This not only
    means that they get the same name, but also that the order  of the methods,
    variables, functions, etc. will have to be the same.
  -# The root directory of the public API headers is at \c /trunk/headers/os.
    In a similar vein, the root of the documentation files is at
    \c /trunk/src/documentation/haiku_book. The subdirectory structure, or
    the division of kits, will also be replicated.
  -# The name of the files is the same as the base of the header files, with
    the \c dox extension. So \c Something.h becomes \c Something.dox. Note
    the case!
  \subsection formalrequirements_headerblock The Header Block
  Every documentation file will begin with the header block. It's basically a
  copyright block, with a reference to the author and with the revision against
  which the documentaton was written.
  \verbatim
 // 
 // Copyright 2007, Haiku Inc. All Rights Reserved.
 //
 // Distributed under the terms of the MIT License.
 //
 //
 // Documentation by: 
 //   Niels Sascha Reedijk <[email protected]>
 // Corresponds to:
 //   /trunk/headers/os/support/String.h  rev 19731
 //   /trunk/src/kits/support/String.cpp  rev 19731
 //
  \endverbatim
  The example above has a few elements that you should take note of:
  -# First of all, every line starts with a C++ single line style comment.
    So it starts with two slashes: \c //. If there is text on a line, the
    tokens are followed by \e one space. If the text is part of a category,
    such as <tt>Documentation by</tt>, put two spaces after the delimeter.
  -# We start with a copyright notice. The first line is empty, then the 
    copyright notice, then another empty line, and then the line on \e MIT,
    followed by two empty lines.
  -# Then there is a label <tt>Documentation by:</tt>, which is followed by
    lines with names and email addresses between brackets.
  -# The final part is underneath the label <tt>Corresponds to:</tt>.
    Underneath there is a list of files and their svn revisions that the
    current documentation is known to correspond with.
  -# The header block ends with an empty C++ comment, and the next block that
    follows underneath will start after an empty line.
  \subsection formalrequirements_blocks Blocks
  Blocks are the basic units of documentation for Doxygen. At first it will
  feel like overkill to use blocks, but realize that Doxygen was initially
  designed to operate on header and source files, and then the blocks of
  documentation would be before the definition or declaration of the
  methods, functions, etcetera. Doxygen is used to blocks and that's why we
  need to reproduce them in our \c dox files.
  Blocks should adhere to the following standards:
  -# All blocks open with \c /*! and close with \c * /
  -# The documentation is in between these markers.
  -# All the contents in between the markers is indended by two spaces.
  -# The maximum width of contents between blocks is 80 columns. <em>Try not
    to cross this limit</em>, because it will severely limit readability.
  Example:
  \verbatim
 /*!
  \fn bool BList::AddItem(void *item)
  \brief Append an item to the list.
  \param item The item to add.
  \retval true The item was appended.
  \retval false Item was not appended, since resizing the list failed.
  \sa AddItem(void *item, int32 index)
 * /
  \endverbatim
  \note Doxygen also allows to use single line comments, starting with \c //!,
    however, we won't use these \b except in case of group markers, which you 
    can read more about in the next section.
  \subsection formalrequirements_delimeters Delimeters
  Many of the header files in the Haiku API just document one class or one
  group of functions. However, there might want to come a time that you come
  across a more complex header and for the sake of clarity of your \c dox file
  you want to mark the sections. Use the standard delimiter marker for this,
  which consists of five slashes, a space, the title of the section, a space
  and another five slashes. Like this: <tt>///// Global Functions /////</tt>.
  \note This is only for the source files and for you as documenter. It will
    not show up in the actual generated documentation!
  \section commands Doxygen Commands
  This section describes all the Doxygen commands that will be used in the
  Haiku API documentation. As a rule, Doxygen commands start with a backslash
  (\\) and are followed by whitespace (such as a space or a newline), with the
  exception of group markers, which will be discussed later on. The commands
  can be divided into several categories, which will be described in the
  following subsections.
  \note This section does not discuss which commands you should actually use
    in documentation. See the next section on \ref style
    on that. This section merely explains the different groupings and
    syntaxes of commands.
  Most commands accept an argument. Arguments can be either of these three
  types:
  - \<single_word\> - The argument is a single word.
  - (until the end of the line) - The argument runs until the end of the line.
  - {paragraph} - The argument runs for an entire paragraph. A paragraph is
    ended by an empty line, or if another command that defines a \ref
    commands_sections sections is found. Note that if you use commands that
    work on a paragraph and you split it over multiple lines (because of the
    maximum line width of 80 characters or because it looks better), you will
    have to indent subsequent lines that belong to the paragraph with two more
    spaces, making the total of four. This is to visually distinguish
    paragraphs for other documenters.
  \subsection commands_definitions Block Definitions
  Because our API documentation is not done in the source, nor in the headers,
  Doxygen needs to be helped with figuring out what the documentation in the
  different blocks actually are about. That's why the first line in a
  documentation block would be one of the following commands:
  - \c \\class \<name\> \n
    Tells doxygen that the following section is going to be on
    the class as specified by \a name.
  - \c \\fn (function declaration) \n
   This block is going to be about the function that corresponds to the given
   declaration. Please note that the declaration is what you find in the source
   file, so if class members are declared, the classname and the scope operator,
   \c ::, are to be added as well. Modifiers such as \c const should be
   included.
  - \c \\var (variable declaration) \n
    This block is going to be about the variable indicated by the declaration.
    This means basically that data members of a class should have the classname
    and the scope operator as well.
  - \c \\typedef (typedef declaration) \n
    This block is going to be about the typedef indicated by the declaration.
    Copy the declaration exactly, including the leading \c typedef keyword.
  - \c \\struct \<name\> \n
    Tells doxygen the section is going to be on the \c struct indicated by
    \a name. 
  - \c \\def \<name\> \n
    This block is going to be about the \c \#define with the identifier \a name.
  - \c \\page \n
    This block represents a page. See the section on \ref commands_pages for
    detailed information on pages.
  \subsection commands_sections Sections in Member Documentation
  If you have a look at the output that Doxygen generates, you can see that
  there are recuring sections in the documentation. Documentation that belongs
  to a certain section should be placed after a command that marks the start
  of that section. All the commands take a paragraph as answer. A paragraph
  ends with a whitespace, or with a command that marks a new section. Note that
  this list only shows the syntax of the commands. For the semantics, have a
  look at the next section on style. In member documentation you can use the
  following:
  - \c \\brief {brief description} \n
    This is the only \b obligatory section. Every member should have at least
    a brief description. 
  - \c \\param \<parameter-name\> {parameter description} \n
    This section describes a parameter with the name \a parameter-name. The
    parameter name must match the function declaration, since doxygen will
    check if all the documented parameters exist.
  - \c \\return {description of the return value} \n
    This section describes the return value. This is a totally free form
    paragraph, whereas \c \\retval has a more structured form.
  - \c \\retval \<value\> {description} \n
    This section describes the return value indicated by \a value. 
  - \c \\see {references} \n
    This section contains references to other parts of the documentation.
  There are also a number of things that can be used in pages and member
  documentation. See the style section to find out which one to use when.
  - \c \\note {text}
  - \c \\attention {text}
  - \c \\warning {text}
  - \c \\remarks {text}
  \subsection commands_markup Markup
  Sometimes you might certain text to have a special markup, to make words
  stand out, but also if you want to have example code within the documentation
  you'll need a special markup. Doxygen defines three types of commands.
  There are commands that work on single words, commands that work on longer
  phrases and commands that define blocks. Basically, the single letter
  commands are commands that work on a the next word. If you need to mark
  multiple words or sentences, use the HTML-style commands. Finally, for
  blocks of code or blocks of text that need to be in "typewriter" font, use
  the block commands. Have a look at the listing:
  - \c \\a \n
    Use to refer to parameters or arguments in a running text, for example
    when refering to parameters in method descriptions.
  - <b>Bold text</b>
    - For single words, use \c \\b.
    - For multiple words, enclose between the \c \<b\> and \c \<\\b\> tags.
  - <tt>Typewriter font</tt> \n
    This can be used to refer to constants, or anything that needs to be in
    a monospace, or typewriter, font. There are a few options
    - \c \\c for single words.
    - \c \<tt\> and \c \<\\tt\> for multiple words or phrases
    - The commands \c \\verbatim and \c \\endverbatim. Everything between these two
    commands will be put in a distinct block that stands out from the rest of the
    text.
    - The commands \c \\code and \c \\endcode do the same, but Doxygen will parse the
    contents and try to mark up the code to make it look just a bit nicer.
  - <em>Emphasis</em>
    - \c \\e for single words.
    - \c \<em\> and \c \<\\em\> for phrases.
  \subsection commands_pages Page Commands
  Pages are a very special element of the documentation. They are not 
  associated with any kind of module, such as files or classes, and therefore,
  since they're not members, some of the structuring commands won't work.
  Important to know is that a page is the complete length of the block, so
  dividing it up in subsections by starting new blocks will not work. Instead,
  doxygen provides some commands to structure text on a page.
  First of all, you define a new page by using the \c \\page command. This
  command takes two arguments: a \c \<name\> and <tt>(a title)</tt>. The name
  is the internal identifier that can be used in linking between pages (see
  \ref commands_miscellaneous for \c \\ref). After you've defined the block
  to be a page, you can start writing the contents. 
  For more complicated pages,  you might want to divide the page up in sections.
  Use the \c \\section command to define a new section. It takes the same
  arguments as \c \\page, namely the \c \<name\> and the <tt>(title)</tt>. If
  you need a deeper hierarchy you may sue \c \\subsection and 
  \c \\subsubsection, again, both with the same syntax. If you need to
  distinguish between sections in subsubsections, you are able to use 
  \c \\paragraph, which takes the same arguments.
  \note Before and after each of the commands above, you need to have an empty
   line for readability. It is not necessary to indent sections and subsections
   more than the normal two spaces, as long as you keep the section markers
   clear.
  \warning If you are entering the realm of subsections and subsubsections,
    think about the nature of your page. Either it needs to be split up into
    multiple pages, or what you're writing is too complex and would be better
    off as a big tutorial on the Haiku website. 
  If you are creating multiple pages that are related, you will be able to
  structure them in a tree by using the \c \\subpage command. This will rank
  the different pages in a tree structure. It will put a link in the place of
  the command, so you should place it at the top of the parent place and use
  it as an index.
  \subsection commands_grouping  Member Grouping Commands
  Doxygen makes it possible to group certain members together. It is used
  in the BString class for example, where the members are grouped by what kind
  of operation they perform, such as appending, finding, etc. Defining groups
  is currently not as powerful as it could be, but if you use it inside classes,
  you will be fine if you follow the instructions presented in this section.
  \note If you are looking on how to add classes to kits, see
    \ref commands_miscellaneous and have a look at the \c \\ingroup command.
  Groups of members are preceeded by a block that describes what the group is
  about. You are required to give each group of members at least a name. Have
  a look at the example: 
  \verbatim
 /*!
  \\name Appending Methods
  These methods append things to the object.
 * /
 //! \@{
 ... names of the methods ...
 //! \@}
  \endverbatim
  The block preceeding the block opening marker, <tt>//! \@{</tt>, contains a
  \c \\name command and a paragraph that gives a description. The header block 
  can be as long or short as you want, but please don't make it too long. See
  the \ref style section on how to effectively write group headers. The
  members that you want to belong to the group are between the group opening
  and closure markers.
  \note Group headers don't have a \c \\brief description.
  \subsection commands_miscellaneous Miscellaneous Commands
  There are some commands that don't fit into the categories above, but that
  you will end up using every now and then. This section will describe those
  commands.
  The first one is \c \\n. This commands sort of belongs to the category of
  markup commands. It basically forces a newline. Because doxygen parses
  paragraphs as continuous, it's not possible to mark up the text using returns
  in the documentation. \c \\n forces a newline in the output. So in HTML it
  will be translated into a \c \<br\\\>. 
  Sometimes there are some parts of the API that you don't want to be visible.
  Since Doxygen extracts all the public and protected members from a class,
  and virtually every member from a file, you might want to force it to hide
  certain things. If so, use the \c \\internal command. If you place this just
  after the block marker, the command will be hidden from documentation. Any
  further documentation or remarks you put inside the block will not be visible
  in the final documentation. 
  Images can be a valuable addition to documentation. To include ones you made,
  use the \c \\image command. It has the following prototype:
  <tt>\\image \<format\> \<file\></tt>. The format is currently fixed at
  \c html. The file refers to the filename relative to the location of the
  documentation file. Any images you want to add should be in the same location
  as the dox file, so only the file name will suffice.
  Modules are defined in the main book, and you can add classes to them by
  using the \c \\ingroup command. This commands adds the class to the module
  and groups it on a separate page. At this moment, the group handling is till
  to be worked out. For now, add the classes to the kit they belong in. In the
  future this might change.
  Finally, it is a good idea to link between parts of the documentation. There
  are two commands for that. The first one is \c \\ref, which enable you to refer
  to pages, sections, etc. that you created yourself. The second one is \c \\link 
  which refers to members. The first one is takes one word as an argument, the
  name of the section, and it inserts a link with the name of the title. \c \\link
  is more complex. It should always be accompanied by \c \\endlink. The first
  word between the two commands is the object that is referred to, and the
  rest is the link text. 
  \section style Writing Guidelines
  This final section will present guidelines for the actual writing of the
  documentation. Both the structure of the documentation, which sections to
  use when, and the style of the writing will be discussed. Before diverging
  into the requirements for file and class descriptions, member descriptions and pages,
  there are some general remarks that apply to all types of documentation.
  First of all, everything you write should be in <em>proper English 
  sentences</em>. Spelling, grammar, punctuation, make sure you adhere to the
  standards. It also means the following:
  - It means that every sentence should at least have a
    subject and a verb (unless it's an imperative statement).
  - Also use the proper terminology. Remember, you are dealing with C++
    here, which means you should use the right names. So use \b method instead
    of function, and data member instead of variable (where appropriate).
  - Avoid informalism. Avoid constructs like 'if you want to disconnect the 
    object', but rather use 'to disconnect the object'. Avoid familiarisms, or
    jokes.
  \remarks It isn't the goal to create dry, legal-style documentation. Just
    try to find a balance. Read through documentation that's already been
    approved to get a hint of what you should be aiming at.
  \remarks If you are having a problem with phrasing certain things, put it
    down in such a way that it says everything it needs to. A proofreader might
    be able to put it in better words.
  Throughout the documentation you might want to provide hints, warnings or
  remarks that might interrupt the flow of the text, or that need to visually
  stand out from the rest. Doxygen provides commands for paragraphs that
  display remarks, warnings, notes and points of attention. You can use these
  commands in case you meet one or more of the following requirements:
  - The point is for a specific audience, such as beginners in
    the Haiku API. Notes on what to read first, or mistakes that can be made
    by beginners will not be for the entire audience, and such should be
    separated. These kinds of notes should be at the end of blocks.
  - The point needs to visually stand out. This is especially the case with
    remarks, but could also apply for other types.
  - The point is not completely relevant to the text and therefore should be
    separated so that it doesn't interrupt the main flow.
  This listing shows which one to use when:
  - \c \\attention
    - Used when the developer is bound to make a mistake, when the API is
      ambiguous. The difference to a warning is that warnings warn for things
      that are the developer's fault, and attention blocks warn for things that
      might go wrong because of the way the API is structured.
    - Used to warn for abuse of the API that might be caused by the way the
      internals of the system are structured. 
  - \c \\warning
    - Used to warn developers for using the API in a certain way. Warnings
      apply especially to new developers that aren't completely familiar with
      the API and that might want to abuse it. For example, the thread safety
      of BString requires a warning. 
  - \c \\note
    - Used to place references to other documentation that might not be
      directly related to the text. For example, BLooper will have a direct
      reference to BHandler in the class description, but BMessenger will be
      mentioned in a note because it does not directly influence the use of
      the class.
    - Can also be used for useful hints or notes that somehow need to stand
      out from the rest of the text.
    - Remarks interact with the text, notes add something unmentioned to it. 
  - \c \\remarks
    - Remarks are small notes that would interrupt the flow of the text. For
      example, if you in a text ignore a certain condition that is so extremely
      rare and uncommon, you can put a remark at the end of the text to tell
      that you have been lying.
    - Remarks interact with the text, notes add something unmentioned to it. 
  \subsection style_files File Descriptions
  The design of Doxygen makes it very file oriented, and this might come off as
  inconvenient. At the moment, how to actually group the documentation is still
  under debate, but it does not change the requirement that a header needs to
  be documented before the members of that header can be documented. As such,
  the first documentation block in your \c dox file will be the block that
  describes the header. Examples:
  \verbatim
 /*!
  \file String.h
  \brief Defines the BString class and global operators and functions for 
    handling strings.
 * /
 /*!
  \file SupportDefs.h
  \brief Defines basic types and definitions for the Haiku API.
 * / 
  \endverbatim
  The first statement defines what the block is about, namely the header file.
  The second element is the \c \\brief remark on what it contains. The first
  file defines the BString class and some global operators. You can see that
  reflected in the description. SupportDefs.h does not define classes, but
  rather a range of different functions and defines, so the text refers to
  that. 
  \remarks \\brief documentation for files is about what it \e implements, as
    header files are passive (whereas members and functions are active). Thus,
    use the third person form of the verb.
  \subsection style_classes Class Descriptions
  Classes are the basic building blocks in the Haiku API and as such will have
  extensive documentation. This section will go over the actual class
  description. This section will present a list of items you should think about
  when writing the class description. This doesn't mean you'll have to put
  every item in, it merely serves as a guiding principle that helps organise
  your thoughts. Have a look at the list:
  -# The \c \\brief description is \b obligatory. This description describes
    what it is. For example, BDataIO: "Abstract interface for objects that
    provide read and write access to data." Note that this description is not
    a full sentence, but it does end with a period.
  -# One or more paragraphs that give a broad overview of what the class can
    do. Describe things like what it works on, when you want to use it, what
    advantage it might give over other directly related alternatives. Also
    describe if a class is made to be derived from, and if so, how. Make
    sure that a developer in the first few paragraphs can judge if what he
    wants to do can be done with this class. 
  -# One or more paragraphs that show how this class ties in with the rest
    of the kit or the API. What objects does it work with, how does it interact
    with the servers, etcetera. 
  -# One or more paragraphs that give a concrete example or use case. Keep it
    tidy and selfcontained. Remember, an example can tell more than a few
    paragraphs of text.
  -# End with a list of references to other classes, functions, pages, etc.
   might be of interest for the reader. 
  When documenting classes, don't be to exhaustive. Avoid becoming a tutorial
  or a complete guide. This documentation is for reference only. If you want to
  enlighten the reader on bigger subjects, consider writing a separate
  documentation page that connects the different points you want to make.
  Also, you don't have to put in any groupings of members in class descriptions.
  If you want to do that, physically divide the members up in groups. Look at
  the \ref commands_grouping for the actual commands, and at \ref style_groups
  for help on writing group headers.
  \subsection style_members Members and Functions
  Members and functions share the same basic doxygen syntax, and they can be
  documented in a similar way. That's why this section deals with them together.
  Documenting members is probably the main thing you'll do when writing the
  actual documentation. There are some guidelines as to how, but the actual
  implementation probably differs per class. Keep the following points in mind:
  -# To repeat a very important fact, the first line is a \c \\fn line. This
    line needs to match the declaration, which is in the source file. This
    means that for members, also the class name and the scope indicator (::)
    should be present. Also note that this line doesn't have to adhere to
    the 80 column width limit.
  -# The first command is always the \c \\brief command. Give a short and
    clear description. The description starts with a capital letter and ends
    with a dot. Don't write the description saying what the method does,
    like "Starts the timer", but rather as what it will do: "Start the timer."
  -# If the brief description doesn't cover all the method or function does,
    then you can add a few paragraphs that explain it in more depth. Don't be
    to verbose, and use an example to illustrate points. Point out any
    potential misunderstandings or problems you expect developers to have, but
    don't repeat the class documentation too much.
  -# You are obliged to then document all the parameters. Use the \c \\param
    command for that. For the description, use a short phrase such as "The 
    offset (zero based) where to begin the move." Note the capital and the dot.
  -# If the function is non-void, then you'll have to specify what it will
    return. In case of fixed values, have a look at \c \\retval. You'll use
    this one when the return type is a bool or a status_t. In case of something
    else, use \c \\return. You can also combine these two. For example, a
    method that returns a lenght (positive) or an error code (negative). 
  -# Use \c \\see if you have any references to other methods, classes or
    global functions. At least document all the overloaded methods. Also add
    methods that do the opposite of this method, or methods that are intimately
    related.
  In case of overloaded members, you'll need to make a decision. If you need
  to copy too much information, you might resort to put in one paragraph with
  the text "This is an overloaded member function, and differs from \<name\> only
  by the type of parameter it takes." That will keep the copying down and will
  point developers right to the place where they can get more documentation.
  Again, like class descriptions, you'll have to find a good middle-ground
  between too much information, and too little. Again, write for the broadest
  audience possible, and resort to notes and warnings for specialised 
  audiences.
  \subsection style_variables Enumerations, Variables and Defines
  This section helps you document (member) variables and defines that define
  constant, as well as enumerations and their values. If you need to document
  a \c \#define macro that takes arguments, have a look at \ref style_members .
  The \c \\brief description of all these types follow a similar structure. 
  They are a short phrase that mentions what the variable contains. Example:
  \verbatim
 /*!
  \var char* BString::fPrivateData
  \brief BString's storage for data.
  This member is deprecated and might even go \c private in future releases.
  If you are planning to derive from this object and you want to manipulate the raw
  string data, please have a look at LockBuffer() and UnlockBuffer().
 * /
  \endverbatim
  The variables you are going to encounter are either \c public or 
  \c protected member variables, or global variables that have a certain
  significance. In the case of member variables, you'll need to document what
  they mean and how the developer should manipulate it. If the class is one 
  that is meant to be derived from, make sure that in the
  description of the variable you mention how it interacts with the others, and
  how the developer should make sure that the internal coherence of the data
  and code members of the inherited class is maintained. 
  Global variables will mostly be constants. If so, document what they stand
  for and what they might be used for, as well as which classes and functions
  depend on that constant. If the variable is meant to be changed by the
  developer, explain what values are valid and which functions and classes
  depend on this variable. 
  Defines are usually used as message constants. Give a short description of
  what the message constant stands for, and where it might be send from and
  where it might be received.
  Enumerations can either be anonymous or named. In case of the latter, you can
  give a description of the enumeration in a documentation block that starts
  with an \c \\enum command, followed by the name of the enumeration. If the
  enumeration is within the scope of a class, prepend the classname and the 
  scope indicator. In case of an anonymous enum, you can only document the
  individual members (which you should do for the named enumerations as well),
  which can be done within code blocks that start with the \c \\var command.
  Doxygen will know that it's an enumeration value, don't worry about mixups.
  If the enumeration value is within a class, prepend the classname and scope
  indicator. Give a short description of the value, which methods react to it, 
  where it might be used, etcetera. Don't go as far as to copy information too 
  much. For example, if you use an enumeration in only one class and you
  document the possible values there, then don't do that again for the
  enumeration documentation: rather just refer to it. That sort of documentation
  belongs to the class description, not to the enumeration.
  \subsection style_groups Groups
  If you subdivide members of classes into groups, you have the ability to
  apply some general information that will be listed above the listing of the
  members in that group. See the section \ref commands_grouping on how to
  define groups. This section is on what to put in the header block.
  First of all, it's probably a good idea to give your group a name. This name
  will be printed as a title and will enhance the clarity of what the group
  contains. If you put the \c \\name command as the first command of a
  group, the rest of the words on that line will be used as title. You should
  chose simple titles, no more than three words.
  It's possible to add one or two paragraphs of information. These paragraphs
  should contain some quick notes on which of the members in that group to use
  for what cause. See it as a quick subdivision which a developer could use
  as a guide to see which method he actually wants to use. Don't go on
  describing the methods in detail though, that's what the member documentation
  is about. Have a look at the example:
  \verbatim
 /*!
  \name Comparison Methods
  There are two different comparison methods. First of all there
  is the whole range of operators that return a boolean value, secondly
  there are methods that return an integer value, both case sensitive
  and case insensitive. 
  There are also global comparison operators and global compare functions.
  You might need these in case you have a sort routine that takes a generic
  comparison function, such as BList::SortItems().
  See the String.h documentation file to see the specifics, though basically
  there are the same as implemented in this class.
 * /
  \endverbatim
  Straight, to the point, gives no more information than necessary. Divides
  the members up into two groups and refers to other functions the developer
  might be looking for. The hard limit is two (short) paragraphs. Using more
  will not improve clarity.
 */
@@ -1,405 +1,426 @@
 // 
 // Copyright 2007, Haiku Inc. All Rights Reserved.
 //
 // Distributed under the terms of the MIT License.
 //
 //
 // Documentation by: 
 //   Niels Sascha Reedijk <[email protected]>
 //   Stefano Ceccherini ([email protected]) 
 // Corresponds to:
 //   /trunk/headers/os/support/DataIO.h  rev 17981
 //   /trunk/src/kits/support/DataIO.cpp  rev 17981
 //
 /*!
-\file DataIO.h
+  \file DataIO.h
-\brief Provides abstract BDataIO and BPositionIO and the derived BMallocIO and BMemoryIO classes.
+  \brief Defines abstract BDataIO and BPositionIO and the derived BMallocIO and BMemoryIO classes.
-Pure virtual BDataIO and BPositioIO classes provide
+  Pure virtual BDataIO and BPositioIO classes provide
-the protocol for Read()/Write()/Seek().
+  the protocol for Read()/Write()/Seek().
-BMallocIO and BMemoryIO classes implement the protocol,
+  BMallocIO and BMemoryIO classes implement the protocol,
-as does BFile in the Storage Kit.
+  as does BFile in the Storage Kit.
 */
-//////////// BDataIO
+///// BDataIO /////
 /*!
-\class BDataIO
+  \class BDataIO
-\ingroup support
+  \ingroup support
-\ingroup libbe
+  \ingroup libbe
-\brief Abstract interface for objects that provides read and write access to data.
+  \brief Abstract interface for objects that provide read and write access to 
    data.
-The interface provided by this class applies to objects or data that are
+  The interface provided by this class applies to objects or data that are
-limited to reading and writing data. Classes derived from this class should
+  limited to reading and writing data. Classes derived from this class should
-reimplement both the Read() and Write() method from this class.
+  reimplement both the Read() and Write() method from this class.
-Candidates of types of data or objects that should be derived from this class
+  Candidates of types of data or objects that should be derived from this class
-are probably broadcasting media streams (which don't support reading at a
+  are probably broadcasting media streams (which don't support reading at a
-certain point in the data) or network streams that output data continously.
+  certain point in the data) or network streams that output data continously.
-Objects and data that support more advanced operations like seeking or
+  Objects and data that support more advanced operations like seeking or
-reading at writing at defined positions should derive their classes from
+  reading at writing at defined positions should derive their classes from
-BPositionIO, which inherits this class.
+  BPositionIO, which inherits this class.
 */
 /*!
-\fn BDataIO::BDataIO()
+  \fn BDataIO::BDataIO()
-\brief This constructor does nothing.
+  \brief This constructor does nothing.
 */
 /*!
-\fn BDataIO::~BDataIO()
+  \fn BDataIO::~BDataIO()
-\brief This destructor does nothing.
+  \brief This destructor does nothing.
 */
 /*!
-\fn virtual ssize_t BDataIO::Read(void *buffer, size_t size) = 0
+  \fn virtual ssize_t BDataIO::Read(void *buffer, size_t size) = 0
-\brief Pure virtual to read data.
+  \brief Pure virtual to read data.
-Your implementation should copy data into \c buffer, with the maximum size
+  Your implementation should copy data into \c buffer, with the maximum size
-of \c size. 
+  of \c size. 
-\return You should return the amount of bytes actually read, or an error code
+  \return You should return the amount of bytes actually read, or an error code
-  in case of failure.
+    in case of failure.
 */
 /*!
-\fn virtual ssize_t BDataIO::Write(const void *buffer, size_t size) = 0
+  \fn virtual ssize_t BDataIO::Write(const void *buffer, size_t size) = 0
-\brief Pure virtual to write data.
+  \brief Pure virtual to write data.
-Your implementation should copy data from \c buffer, with the maximum size
+  Your implementation should copy data from \c buffer, with the maximum size
-of \c size. 
+  of \c size. 
-\return You should return the amount of bytes actually written, or an error code
+  \return You should return the amount of bytes actually written, or an error 
-  in case of failure.
+    code in case of failure.
 */
 //////////// BPositionIO
 /*!
-\class BPositionIO
+  \class BPositionIO
-\ingroup support
+  \ingroup support
-\ingroup libbe
+  \ingroup libbe
-\brief Abstract interface that provides advanced read, write and seek access to data.
+  \brief Abstract interface that provides advanced read, write and seek access
    to data.
-The interface of this object applies to objects or data that allows
+  The interface of this object applies to objects or data that allows
-position-aware reading and writing of data. Classes that derive from this
+  position-aware reading and writing of data. Classes that derive from this
-class should at least reimplement ReadAt(), WriteAt(), Seek(), Position(),
+  class should at least reimplement ReadAt(), WriteAt(), Seek(), Position(),
-SetSize() and GetSize() methods.
+  SetSize() and GetSize() methods.
-A good example of a form of data that can derive from this object, are files.
+  A good example of a form of data that can derive from this object, are files.
-The BFile class derives from BPositionIO and provides this interface to files.
+  The BFile class derives from BPositionIO and provides this interface to 
-If your object or data only supports linear reading and writing, consider
+  files. If your object or data only supports linear reading and writing, 
-deriving from the baseclass BDataIO.
+  consider deriving from the baseclass BDataIO.
-A final note, from BDataIO this class inherits Read() and Write(). The default
+  A final note, from BDataIO this class inherits Read() and Write(). The 
-implementation is to read or write the data at the current position indicated
+  default implementation is to read or write the data at the current position 
-by Position(). Reimplement the methods if you require a different behaviour.
+  indicated by Position(). Reimplement the methods if you require a different
  behaviour.
 */
 /*!
-\fn BPositionIO::BPositionIO()
+  \fn BPositionIO::BPositionIO()
-\brief This constructor does nothing.
+  \brief This constructor does nothing.
 */
 /*!
-\fn virtual BPositionIO::~BPositionIO()
+  \fn virtual BPositionIO::~BPositionIO()
-\brief This destructor does nothing.
+  \brief This destructor does nothing.
 */
 /*!
-\fn virtual ssize_t BPositionIO::Read(void *buffer, size_t size)
+  \fn virtual ssize_t BPositionIO::Read(void *buffer, size_t size)
-\brief Read data from current position.
+  \brief Read data from current position.
-This method is derived from BDataIO. The default implementation reads data from
+  This method is derived from BDataIO. The default implementation reads data 
-the current position of the cursor, pointed at by Position(). If you require
+  from the current position of the cursor, pointed at by Position(). If you
-different behaviour, please look at BDataIO::Read() for what is expected of
+  require different behaviour, please look at BDataIO::Read() for what is 
-this method.
+  expected of this method.
 */
 /*!
-\fn virtual ssize_t BPositionIO::Write(const void *buffer, size_t size)
+  \fn virtual ssize_t BPositionIO::Write(const void *buffer, size_t size)
-\brief Write data to the current position.
+  \brief Write data to the current position.
-This method is derived from BDataIO. The default implementation writes data to
+  This method is derived from BDataIO. The default implementation writes data
-the current position of the cursor, pointed at by Position(). If you require
+  to the current position of the cursor, pointed at by Position(). If you
-different behaviour, please look at BDataIO::Write() for what is expected of
+  require different behaviour, please look at BDataIO::Write() for what is
-this method.
+  expected of this method.
 */
 /*!
-\fn virtual ssize_t BPositionIO::ReadAt(off_t position, void *buffer, size_t size) = 0
+  \fn virtual ssize_t BPositionIO::ReadAt(off_t position, void *buffer, size_t size) = 0
-\brief Pure virtual to read data from a certain position.
+  \brief Pure virtual to read data from a certain position.
-Your implementation should copy data from the position indicated by \c position
+  Your implementation should copy data from the position indicated by 
-into the \c buffer with the maximum size of \c size.
+  \a position into the \a buffer with the maximum size of \a size.
-\return The amount of bytes actually read, or an error code.
+  \return The amount of bytes actually read, or an error code.
 */
 /*!
-\fn virtual ssize_t BPositionIO::WriteAt(off_t position, const void *buffer, size_t size) = 0
+  \fn virtual ssize_t BPositionIO::WriteAt(off_t position, const void *buffer, size_t size) = 0
-\brief Pure virtual to write data to a certain position.
+  \brief Pure virtual to write data to a certain position.
-Your implementation should copy data from \c buffer to the position indicated
+  Your implementation should copy data from \a buffer to the position indicated
-by \c buffer with the maximum size of \c size.
+  by \a buffer with the maximum size of \a size.
-\return The amount of bytes actually written, or an error code.
+  \return The amount of bytes actually written, or an error code.
 */
 /*!
-\fn virtual off_t BPositionIO::Seek(off_t position, uint32 seekMode) = 0
+  \fn virtual off_t BPositionIO::Seek(off_t position, uint32 seekMode) = 0
-\brief Pure virtual to move the cursor to a certain position.
+  \brief Pure virtual to move the cursor to a certain position.
-Your implementation should move the position of the cursor to the provided
+  Your implementation should move the position of the cursor to the provided
-point. What this actually means, depends on your object or data. 
+  point. What this actually means, depends on your object or data. 
-\param position An integer that defines a position.
+  \param position An integer that defines a position.
-\param seekMode You will get one of the following values:
+  \param seekMode You will get one of the following values:
-  - \c SEEK_SET Set the cursor to the position indicated by \c position.
+    - \c SEEK_SET Set the cursor to the position indicated by \c position.
-  - \c SEEK_END Set the cursor to the end of the buffer, and go
+    - \c SEEK_END Set the cursor to the end of the buffer, and go
-    \c position beyond that.
+      \c position beyond that.
-  - \c SEEK_CUR Set the cursor the the current position plus \c position.
+    - \c SEEK_CUR Set the cursor the the current position plus \c position.
-\return The new position.
+  \return The new position.
 */
 /*!
-\fn virtual off_t BPositionIO::Position() const = 0
+  \fn virtual off_t BPositionIO::Position() const = 0
-\brief Pure virtual to return the current position of the cursor.
+  \brief Pure virtual to return the current position of the cursor.
-\return
+  \return Your implementation should return the current position of the cursor.
 Your implementation should return the current position of the cursor.
 */
 /*!
-\fn virtual status_t BPositionIO::SetSize(off_t size)
+  \fn virtual status_t BPositionIO::SetSize(off_t size)
-\brief Set the size of the object or data.
+  \brief Set the size of the object or data.
-The default implementation returns \c B_ERROR. If your object or data allows
+  The default implementation returns \c B_ERROR. If your object or data allows
-the size to be changed, reimplement this method.
+  the size to be changed, reimplement this method.
-\return Return \c B_OK if everything succeeded, else return the appropriate
+  \return Return \c B_OK if everything succeeded, else return the appropriate
-  error code.
+    error code.
 */
 /*!
-\fn virtual status_t BPositionIO::GetSize(off_t* size) const
+  \fn virtual status_t BPositionIO::GetSize(off_t* size) const
-\brief Get the size of the object or data.
+  \brief Get the size of the object or data.
-The default implementation uses Seek() with the \c SEEK_END flag to
+  The default implementation uses Seek() with the \c SEEK_END flag to
-determine the size of the buffer. If your data or object has a different way
+  determine the size of the buffer. If your data or object has a different way
-of determining size, reimplement this method.
+  of determining size, reimplement this method.
-Please check that NULL is not passed into \c size if you reimplement it in
+  Please check that NULL is not passed into \c size if you reimplement it in
-your class.
+  your class.
-\param[out] size The size of the object is put into this parameter.
+  \param[out] size The size of the object is put into this parameter.
-\return This method returns \c B_OK on success or an error code on error.
+  \return This method returns \c B_OK on success or an error code on error.
-\sa Seek()
+  \see Seek()
 */
 //////////// BMemoryIO
 /*!
-\class BMemoryIO
+  \class BMemoryIO
-\ingroup support
+  \ingroup support
-\ingroup libbe
+  \ingroup libbe
-\brief A BPositionIO derived class that works on memory buffers.
+  \brief A BPositionIO derived class that works on memory buffers.
-This class is used if you require access that confirms to the BPositionIO
+  This class is used if you require access that confirms to the BPositionIO
-interface on memory buffers that you created. If you would like to use that
+  interface on memory buffers that you created. If you would like to use that
-interface on new buffers, have a look at BMallocIO.
+  interface on new buffers, have a look at BMallocIO.
-This class is particularly useful if you would like to use a class or method
+  This class is particularly useful if you would like to use a class or method
-that are written to make use of the BPositionIO interface. It might also
+  that are written to make use of the BPositionIO interface. It might also
-be used for 'secure' reading and writing from buffers, since this class
+  be used for 'secure' reading and writing from buffers, since this class
-automatically checks the bounds of anything you might want to do.
+  automatically checks the bounds of anything you might want to do.
-This class reimplements the Read(), Write(), ReadAt(), Writeat(), Seek() and
+  This class reimplements the Read(), Write(), ReadAt(), Writeat(), Seek() and
-Position() interface from BPositionIO.
+  Position() interface from BPositionIO.
 */
 /*!
-\fn BMemoryIO::BMemoryIO(void *data, size_t length)
+  \fn BMemoryIO::BMemoryIO(void *data, size_t length)
-\brief Create a read/write object.
+  \brief Create a read/write object.
-\param data A pointer to the buffer to adopt.
+  \param data A pointer to the buffer to adopt.
-\param length The size of the buffer.
+  \param length The size of the buffer.
-\sa BMemoryIO(const void *buffer, size_t length) for a read-only implementation.
+  \see BMemoryIO(const void *buffer, size_t length) for a read-only 
    implementation.
 */
 /*!
-\fn BMemoryIO::BMemoryIO(const void *buffer, size_t length)
+  \fn BMemoryIO::BMemoryIO(const void *buffer, size_t length)
-\brief Create a read-only object.
+  \brief Create a read-only object.
-\param buffer A pointer to the \c const (read-only) buffer to adopt.
+  \param buffer A pointer to the \c const (read-only) buffer to adopt.
-\param length The size of the buffer.
+  \param length The size of the buffer.
-\sa BMemoryIO(void *buffer, size_t length) for a read-write implementation.
+  \see BMemoryIO(void *buffer, size_t length) for a read-write implementation.
 */
 /*!
-\fn BMemoryIO::~BMemoryIO()
+  \fn BMemoryIO::~BMemoryIO()
-\brief The destructor does nothing.
+  \brief The destructor does nothing.
 */
 /*!
-\fn ssize_t BMemoryIO::ReadAt(off_t pos, void *buffer, size_t size)
+  \fn ssize_t BMemoryIO::ReadAt(off_t pos, void *buffer, size_t size)
-\brief Read from a given position.
+  \brief Read from a given position.
-\param[in] pos The offset where to start reading data.
+  \param[in] pos The offset where to start reading data.
-\param[out] buffer The buffer to copy the read bytes into.
+  \param[out] buffer The buffer to copy the read bytes into.
-\param[in] size The size of the \c buffer.
+  \param[in] size The size of the \a buffer.
-\return The amount of read bytes or an error code.
+  \return The amount of read bytes or an error code.
-\retval B_BAD_VALUE The position is less than zero or the buffer given on
+  \retval B_BAD_VALUE The position is less than zero or the buffer given on
-  construction is invalid.
+    construction is invalid.
 */
 /*!
-\fn ssize_t BMemoryIO::WriteAt(off_t pos, const void *buffer, size_t size)
+  \fn ssize_t BMemoryIO::WriteAt(off_t pos, const void *buffer, size_t size)
-\brief Write to a given position.
+  \brief Write at a given position.
-\param pos The offset to write to.
+  \param pos The offset to write to.
-\param buffer The buffer to copy the bytes from.
+  \param buffer The buffer to copy the bytes from.
-\param size The number of bytes to write.
+  \param size The number of bytes to write.
-\return The amount of bytes written or an error code.
+  \return The amount of bytes written or an error code.
-\retval B_NOT_ALLOWED The object is constructed as a read-only object.
+  \retval B_NOT_ALLOWED The object is constructed as a read-only object.
-\retval B_BAD_VALUE The position is less than zero or the buffer given on
+  \retval B_BAD_VALUE The position is less than zero or the buffer given on
-  construction is invalid.
+    construction is invalid.
 */
 /*!
-\fn off_t BMemoryIO::Seek(off_t position, uint32 seek_mode)
+  \fn off_t BMemoryIO::Seek(off_t position, uint32 seek_mode)
-\brief Move the cursor to a given position.
+  \brief Move the cursor to a given position.
-\param position The position to move the cursor to.
+  \param position The position to move the cursor to.
-\param seek_mode The mode determines where the cursor is placed. Possibilities:
+  \param seek_mode The mode determines where the cursor is placed. 
-  - \c SEEK_SET The cursor is set to \c position.
+    Possibilities:
-  - \c SEEK_CUR The \c position is added to the current position of the cursor.
+    - \c SEEK_SET The cursor is set to \a position.
-  - \c SEEK_END The cursor is put at the end of the data, plus
+    - \c SEEK_CUR The \a position is added to the current position of the 
-    \c position added to it. 
+      cursor.
-\return The new position.
+    - \c SEEK_END The cursor is put at the end of the data, plus
      \a position added to it. 
  \return The new position.
 */
 /*!
-\fn off_t BMemoryIO::Position() const
+  \fn off_t BMemoryIO::Position() const
-\brief Return the current position.
+  \brief Return the current position.
 */
 /*!
-\fn status_t BMemoryIO::SetSize(off_t size)
+  \fn status_t BMemoryIO::SetSize(off_t size)
-\brief Resize the buffer.
+  \brief Resize the buffer.
-This method does not actually resize the buffer. If the new size is greater
+  This method does not actually resize the buffer. If the new size is greater
-than the size of the buffer, resizing will fail. It will only succeed if the new
+  than the size of the buffer, resizing will fail. It will only succeed if the 
-size is less than the size of the buffer. The buffer itself will not be resized
+  new size is less than the size of the buffer. The buffer itself will not be
-though. 
+  resized though. 
-This method might be useful in some cases. If the buffer is larger than the
+  This method might be useful in some cases. If the buffer is larger than the
-data it holds, changing the size will enable you to use the Seek() method
+  data it holds, changing the size will enable you to use the Seek() method
-with the flag \c SEEK_END and not get an error if you read or write from
+  with the flag \c SEEK_END and not get an error if you read or write from
-that position, since you actually have a buffer at the end.
+  that position, since you actually have a buffer at the end.
-\retval B_OK The buffer is resized.
+  \retval B_OK The buffer is resized.
-\retval B_NOT_ALLOWED The buffer is read-only.
+  \retval B_NOT_ALLOWED The buffer is read-only.
-\retval B_ERROR The \c size is larger than the size of the buffer.
+  \retval B_ERROR The \c size is larger than the size of the buffer.
 */
 //////////// BMallocIO
 /*!
-\class BMallocIO
+  \class BMallocIO
-\ingroup support
+  \ingroup support
-\ingroup libbe
+  \ingroup libbe
-\brief A BPositionIO derived class that creates a memory buffer.
+  \brief A BPositionIO derived class that creates a memory buffer.
-This class creates a memory buffer and provides a BPositionIO interface to work
+  This class creates a memory buffer and provides a BPositionIO interface to
-on it. The memory buffer grows and shrinks automatically.
+  work on it. The memory buffer grows and shrinks automatically.
-This is especially useful if you want to use a method or function that
+  This is especially useful if you want to use a method or function that
-works on an object derived from BPositionIO and you want to do something with
+  works on an object derived from BPositionIO and you want to do something with
-the resulting data, or it could be useful if you want to read and write to
+  the resulting data, or it could be useful if you want to read and write to
-memory in a safe way, since this class has boundary checking.
+  memory in a safe way, since this class has boundary checking.
-BMallocIO allocates a buffer based on a certain blocksize. This provides a
+  BMallocIO allocates a buffer based on a certain blocksize. This provides a
-mechanism that will prevent it from needing to allocate new memory too often.
+  mechanism that will prevent it from needing to allocate new memory too often.
-The default blocksize is 256 bytes, you can change it with SetBlockSize(). If you
+  The default blocksize is 256 bytes, you can change it with SetBlockSize(). If
-are sure you are going to use a bigger buffer, change the blocksize so that
+  you are sure you are going to use a bigger buffer, change the blocksize so 
-you won't have to allocate more memory too often, especially if you use this
+  that you won't have to allocate more memory too often, especially if you use
-class in performance-critical code.
+  this class in performance-critical code.
-If you require a BPositionIO derived object that works on buffers you provide,
+  If you require a BPositionIO derived object that works on buffers you
-have a look at BMemoryIO.
+  provide, have a look at BMemoryIO.
 */
 /*!
-\fn BMallocIO::BMallocIO()
+  \fn BMallocIO::BMallocIO()
-\brief Create a new memory buffer with block size 256.
+  \brief Create a new memory buffer with block size 256.
-\sa SetBlockSize()
+  \see SetBlockSize()
 */
 /*!
-\fn BMallocIO::~BMallocIO()
+  \fn BMallocIO::~BMallocIO()
-\brief Destroy the object and free the internal buffer.
+  \brief Destroy the object and free the internal buffer.
 */
 /*!
-\fn ssize_t BMallocIO::ReadAt(off_t pos, void *buffer, size_t size)
+  \fn ssize_t BMallocIO::ReadAt(off_t pos, void *buffer, size_t size)
-\brief Read data at a certain position.
+  \brief Read data at a certain position.
-\param[in] pos Offset into the data where to read from.
+  \param[in] pos Offset into the data where to read from.
-\param[out] buffer The buffer to copy the read bytes in.
+  \param[out] buffer The buffer to copy the read bytes in.
-\param [in] size Size of the buffer.
+  \param [in] size Size of the buffer.
-\return The number of read bytes, or \c B_BAD_VALUE if
+  \return The number of read bytes, or \c B_BAD_VALUE if
-  the provided \c buffer is invalid.
+    the provided \a buffer is invalid.
 */
 /*!
-\fn ssize_t BMallocIO::WriteAt(off_t pos, const void *buffer, size_t size)
+  \fn ssize_t BMallocIO::WriteAt(off_t pos, const void *buffer, size_t size)
-\brief Write data to a certain position.
+  \brief Write data to a certain position.
-\param pos Offset into the data where to write to.
+  \param pos Offset into the data where to write to.
-\param buffer The buffer to copy from.
+  \param buffer The buffer to copy from.
-\param size The size of the buffer.
+  \param size The size of the buffer.
-\return The number of bytes written or \c B_BAD_VALUE if the provided \c buffer
+  \return The number of bytes written or \c B_BAD_VALUE if the provided.
-is invalid.
+  \a buffer is invalid.
 */
 /*!
-\fn off_t BMallocIO::Seek(off_t position, uint32 seekMode)
+  \fn off_t BMallocIO::Seek(off_t position, uint32 seekMode)
-\brief Move the cursor to a given position.
+  \brief Move the cursor to a given position.
-\param position The position to move the cursor to.
+  \param position The position to move the cursor to.
-\param seekMode The mode determines where the cursor is placed. Possibilities:
+  \param seekMode The mode determines where the cursor is placed. Possibilities:
-  - \c SEEK_SET The cursor is set to \c position.
+    - \c SEEK_SET The cursor is set to \a position.
-  - \c SEEK_CUR The \c position is added to the current position of the cursor.
+    - \c SEEK_CUR The \c position is added to the current position of the
-  - \c SEEK_END The cursor is put at the end of the data, plus
+      cursor.
-    \c position added to it. 
+    - \c SEEK_END The cursor is put at the end of the data, plus
-\return The new position.
+      \a position added to it. 
  \return The new position.
 */
 /*!
-\fn off_t BMallocIO::Position() const
+  \fn off_t BMallocIO::Position() const
-\brief Return the position of the cursor.
+  \brief Return the position of the cursor.
 */
 /*!
-\fn status_t BMallocIO::SetSize(off_t size)
+  \fn status_t BMallocIO::SetSize(off_t size)
-\brief Change the size of the buffer.
+  \brief Change the size of the buffer.
-This method changes the size of the current buffer. If \c size is smaller than
+  This method changes the size of the current buffer. If \a size is smaller 
-the current size, the data will be cleared.
+  than the current size, the data will be cleared.
-\param size The new size of the buffer.
+  \param size The new size of the buffer.
-\retval B_OK Resizing the data succeeded.
+  \retval B_OK Resizing the data succeeded.
-\retval B_NO_MEMORY Failed to allocate the necessary memory.
+  \retval B_NO_MEMORY Failed to allocate the necessary memory.
 */
 /*!
-\fn void BMallocIO::SetBlockSize(size_t blockSize)
+  \fn void BMallocIO::SetBlockSize(size_t blockSize)
-\brief Change the block size to a certain value.
+  \brief Change the block size to a certain value.
-This class allocates memory in blocks. If you are in performance-critical code
+  This class allocates memory in blocks. If you are in performance-critical 
-you might want to tweak this setting to create a better performance in case you
+  code you might want to tweak this setting to create a better performance in
-know you are going to allocate more than the default blocksize of 256.
+  case you know you are going to allocate more than the default blocksize of
  256.
-\param blockSize The new block size.
+  \param blockSize The new block size.
 */
 /*!
-\fn const void *BMallocIO::Buffer() const
+  \fn const void *BMallocIO::Buffer() const
-\brief Return a pointer to the internal buffer.
+  \brief Return a pointer to the internal buffer.
-As with any pointer to internal buffers you can retrieve with the Haiku API,
+  As with any pointer to internal buffers the Haiku API exposes,
-make sure you don't change anything since it doesn't belong to you.
+  make sure you don't change anything since it doesn't belong to you.
 */
 /*!
-\fn size_t BMallocIO::BufferLength() const
+  \fn size_t BMallocIO::BufferLength() const
-\brief Return the number of bytes in the buffer.
+  \brief Return the number of bytes in the buffer.
-This number doesn't have to be the same size as the buffer is. Because memory
+  This number doesn't have to be the same size as the buffer is. Because memory
-is allocated in blocks the actual size of the buffer may be greater, but this
+  is allocated in blocks the actual size of the buffer may be greater, but this
-method only returns the number of bytes that are actually used.
+  method only returns the number of bytes that are actually used.
 */
@@ -1,352 +1,368 @@
 // 
 // Copyright 2007, Haiku Inc. All Rights Reserved.
 //
 // Distributed under the terms of the MIT License.
 //
 //
 // Documentation by: 
-//   Niels Sascha Reedijk <[email protected]>
+//   Niels Sascha Reedijk <[email protected]
 // Corresponds to:
 //   /trunk/headers/os/support/List.h  rev 19972
 //   /trunk/src/kits/support/List.cpp  rev 18649
 //
 /*!
-\file List.h
+  \file List.h
-\brief Implements a list implementation.
+  \brief Defines the BList class.
 */
 /*!
-\class BList
+  \class BList
-\ingroup support
+  \ingroup support
-\ingroup libbe
+  \ingroup libbe
-\brief An ordered container that is designed to hold generic \c void * objects.
+  \brief An ordered container that is designed to hold generic \c void * 
    objects.
-This class is designed to be used for a variety of tasks. Unlike similar
+  This class is designed to be used for a variety of tasks. Unlike similar
-implementations in other libraries, this class is not based on templates,
+  implementations in other libraries, this class is not based on templates,
-and as such is inherently not typed. So it will be the job of the coder to
+  and as such is inherently not typed. So it will be the job of the coder to
-make sure proper data will be entered, since the compiler cannot check this.
+  make sure proper data will be entered, since the compiler cannot check this.
-BList contains a list of items that will grow and shrink depending on
+  BList contains a list of items that will grow and shrink depending on
-how much items are in it. So you will not have to do any of the
+  how much items are in it. So you will not have to do any of the
-memory management. Furthermore, it's ordered. Those properties make it
+  memory management. Furthermore, it's ordered. Those properties make it
-useful in a whole range of situations, for example in the interface kit in 
+  useful in a whole range of situations, for example in the interface kit in 
-the BListView class.
+  the BListView class.
-A note on ownership of the objects might come in handy. BList at no time
+  A note on ownership of the objects might come in handy. BList at no time
-assumes ownership of the objects, so removing items from the list will
+  assumes ownership of the objects, so removing items from the list will
-only remove those items from the list, it will not delete the item. In the
+  only remove those items from the list, it will not delete the item. In the
-same spirit you should also make sure that before you might delete an
+  same spirit you should also make sure that before you might delete an
-object that's in a list, you will remove it from the list first. 
+  object that's in a list, you will remove it from the list first. 
-\warning This class is not thread-safe.
+  \warning This class is not thread-safe.
-The class implements methods to add and remove items, reorder items,
+  The class implements methods to add and remove items, reorder items,
-retrieve items, querying for items and some advanced methods which let
+  retrieve items, querying for items and some advanced methods which let
-you perform a certain tasks to all the items of the list.
+  you perform a certain tasks to all the items of the list.
 */
 /*!
-\fn BList::BList(int32 count = 20)
+  \fn BList::BList(int32 count = 20)
-\brief Create a new list with a number of empty slots.
+  \brief Create a new list with a number of empty slots.
-The memory management of this class allocates new memory per block. The
+  The memory management of this class allocates new memory per block. The
-\c count parameter can be tweaked to determine the size of those blocks.
+  \c count parameter can be tweaked to determine the size of those blocks.
-In general, if you know your list is only going to contain a fixed maximum
+  In general, if you know your list is only going to contain a fixed maximum
-number of items, pass that value. If you expect your list to have very few items,
+  number of items, pass that value. If you expect your list to have very few 
-it's probably safe to choose a low number. This is as to prevent the list from
+  items, it's probably safe to choose a low number. This is as to prevent the 
-taking up unneccesary memory. If you expect the list to contain a large
+  list from taking up unneccesary memory. If you expect the list to contain a 
-number of items, choose a higher value, since every time the memory is full, all
+  large number of items, choose a higher value, since every time the memory is 
-the items have to be copied into a new piece of allocated memory which is
+  full, all the items have to be copied into a new piece of allocated memory 
-an expensive operation.
+  which is an expensive operation.
-If you are unsure, you don't have to break your head over this. As long as you
+  If you are unsure, you don't have to break your head over this. As long as 
-don't use a lot of lists or as long as the list isn't used in one of the
+  you don't use a lot of lists or as long as the list isn't used in one of the
-performance critical parts of the code, you are safe to go with the default
+  performance critical parts of the code, you are safe to go with the default
-value.
+  value.
-\param count The size of the blocks of memory allocated.
+  \param count The size of the blocks of memory allocated.
 */
 /*!
-\fn BList::BList(const BList& anotherList)
+  \fn BList::BList(const BList& anotherList)
-\brief Copy constructor, copies a complete list into this one.
+  \brief Copy constructor. Copy a complete list into this one.
 */
 /*!
-\fn BList::~BList()
+  \fn BList::~BList()
-\brief Destroy the list.
+  \brief Destroy the list.
-Please note that as BList does not assume ownership of the objects,
+  Please note that as BList does not assume ownership of the objects,
-only the list will be freed, not the objects that are held in it.
+  only the list will be freed, not the objects that are held in it.
 */
 /*!
-\fn BList& BList::operator=(const BList &list)
+  \fn BList& BList::operator=(const BList &list)
-\brief Copy another list into this object.
+  \brief Copy another list into this object.
 */
 /*!
-\name Adding and removing items
+  \name Adding and removing items
 */
 //! @{
 /*!
-\fn bool BList::AddItem(void *item, int32 index)
+  \fn bool BList::AddItem(void *item, int32 index)
-\brief Add an item at a certain position.
+  \brief Add an item at a certain position.
-\param item The item to add.
+  \param item The item to add.
-\param index The place in the list.
+  \param index The place in the list.
-\retval true The item was added.
+  \retval true The item was added.
-\retval false Item was not added. Either the index was  negative or invalid,
+  \retval false Item was not added. Either the index was  negative or invalid,
-  or resizing the list failed.
+    or resizing the list failed.
-\sa AddItem(void *item)
+  \see AddItem(void *item)
 */
 /*!
-\fn bool BList::AddItem(void *item)
+  \fn bool BList::AddItem(void *item)
-\brief Append an item to the list.
+  \brief Append an item to the list.
-\param item The item to add.
+  \param item The item to add.
-\retval true The item was appended.
+  \retval true The item was appended.
-\retval true The item was added.
+  \retval false Item was not appended, since resizing the list failed.
-\retval false Item was not appended, since resizing the list failed.
+  \see AddItem(void *item, int32 index)
 \sa AddItem(void *item, int32 index)
 */
 /*!
-\fn bool BList::AddList(const BList *list, int32 index)
+  \fn bool BList::AddList(const BList *list, int32 index)
-\brief Add items from another list to this list at a certain position.
+  \brief Add items from another list to this list at a certain position.
-Note that the \c list parameter is \c const, so the original list will not be altered.
+  Note that the \a list parameter is \c const, so the original list will not be
  altered.
-\param list The list to be added.
+  \param list The list to be added.
-\param index The position in the current list where the new item(s) should be put.
+  \param index The position in the current list where the new item(s) should be
-\retval true The list was added. 
+    put.
-\retval false Failed to insert the list, due to the fact that resizing our list failed. 
+  \retval true The list was added. 
-\sa AddList(const BList *list)
+  \retval false Failed to insert the list, due to the fact that resizing our
    list failed. 
  \see AddList(const BList *list)
 */
 /*!
-\fn bool BList::AddList(const BList *list)
+  \fn bool BList::AddList(const BList *list)
-\brief Append a list to this list.
+  \brief Append a list to this list.
-Note that the \c list parameter is \c const, so the original list will not be altered.
+  Note that the \a list parameter is \c const, so the original list will not
  be altered.
-\param list The list to be appended.
+  \param list The list to be appended.
-\retval true The list was appended. 
+  \retval true The list was appended. 
-\retval false Failed to append the list, due to the fact that resizing our list failed. 
+  \retval false Failed to append the list, due to the fact that resizing our
-\sa AddList(const BList *list, int32 index)
+    list failed. 
  \see AddList(const BList *list, int32 index)
 */
 /*!
-\fn bool BList::RemoveItem(void *item)
+  \fn bool BList::RemoveItem(void *item)
-\brief Remove an item from the list.
+  \brief Remove an item from the list.
-\param item The item that should be removed.
+  \param item The item that should be removed.
-\retval true The item was found and removed.
+  \retval true The item was found and removed.
-\retval false The item was not in this list and thus not removed.
+  \retval false The item was not in this list and thus not removed.
-\sa RemoveItem(int32 index)
+  \see RemoveItem(int32 index)
 */
 /*!
-\fn void * BList::RemoveItem(int32 index)
+  \fn void * BList::RemoveItem(int32 index)
-\brief Remove the item at \c index from the list.
+  \brief Remove the item at \a index from the list.
-\param index The item that should be removed.
+  \param index The item that should be removed.
-\return The pointer to the item that was removed, or \c NULL in case the
+  \return The pointer to the item that was removed, or \c NULL in case the
-  index was invalid.
+    index was invalid.
-\sa RemoveItem(void *item)
+  \see RemoveItem(void *item)
 */
 /*!
-\fn bool BList::RemoveItems(int32 index, int32 count)
+  \fn bool BList::RemoveItems(int32 index, int32 count)
-\brief Remove a number of items starting at a certain position.
+  \brief Remove a number of items starting at a certain position.
-If the count parameter is larger than the number of items in the list,
+  If the count parameter is larger than the number of items in the list,
-all the items from the offset to the end will be removed.
+  all the items from the offset to the end will be removed.
-\param index The offset in the list where removal should start.
+  \param index The offset in the list where removal should start.
-\param count The number of items to remove.
+  \param count The number of items to remove.
-\retval true Removal succeeded.
+  \retval true Removal succeeded.
-\retval false Failed to remove the items because the index was invalid.
+  \retval false Failed to remove the items because the index was invalid.
 */
 /*!
-\fn bool BList::ReplaceItem(int32 index, void *newItem)
+  \fn bool BList::ReplaceItem(int32 index, void *newItem)
-\brief Replace a item with another one.
+  \brief Replace a item with another one.
-\param index The offset in the list where to put the item.
+  \param index The offset in the list where to put the item.
-\param newItem The new item to put in the list.
+  \param newItem The new item to put in the list.
-\retval true Item replaced.
+  \retval true Item replaced.
-\retval false The index was invalid.
+  \retval false The index was invalid.
 */
 /*!
-\fn void BList::MakeEmpty()
+  \fn void BList::MakeEmpty()
-\brief Clear all the items from the list.
+  \brief Clear all the items from the list.
-Please note that this does not free the items. 
+  Please note that this does not free the items. 
 */
 //! @}
 /*!
-\name Reordering items
+  \name Reordering items
 */
 //! @{
 /*!
-\fn void BList::SortItems(int (*compareFunc)(const void *, const void *))
+  \fn void BList::SortItems(int (*compareFunc)(const void *, const void *))
-\brief Sort the items with the use of a supplied comparison function.
+  \brief Sort the items with the use of a supplied comparison function.
-The function should take two \c const pointers as arguments and should return an
+  The function should take two \c const pointers as arguments and should return
-integer.
+  an integer.
-For an example, see the Compare(const BString *, const BString *) function. 
+  For an example, see the Compare(const BString *, const BString *) function. 
 */
 /*!
-\fn bool BList::SwapItems(int32 indexA, int32 indexB)
+  \fn bool BList::SwapItems(int32 indexA, int32 indexB)
-\brief Swap two items.
+  \brief Swap two items.
-\param indexA The first item.
+  \param indexA The first item.
-\param indexB The second item.
+  \param indexB The second item.
-\retval true Swap succeeded.
+  \retval true Swap succeeded.
-\retval false Swap failed because one of the indexes were invalid.
+  \retval false Swap failed because one of the indexes were invalid.
 */
 /*! 
-\fn bool BList::MoveItem(int32 fromIndex, int32 toIndex)
+  \fn bool BList::MoveItem(int32 fromIndex, int32 toIndex)
-\brief Move an item to a new place
+  \brief Move an item to a new place
-This moves a list item from posititon a to position b, moving the appropriate 
+  This moves a list item from posititon a to position b, moving the appropriate 
-block of list elements to make up for the move.  For example, in the array:
+  block of list elements to make up for the move.  For example, in the array:
-\verbatim
+  \verbatim
 A B C D E F G H I J
-\endverbatim
+  \endverbatim
-Moveing 1(B)->6(G) would result in this:
+
-\verbatim
+  Moveing 1(B)->6(G) would result in this:
  \verbatim
 A C D E F G B H I J
-\endverbatim
+  \endverbatim
-\param fromIndex The original location.
+  \param fromIndex The original location.
-\param toIndex The new location.
+  \param toIndex The new location.
-\retval true Move succeeded.
+  \retval true Move succeeded.
-\retval false Move failed since the indexes were invalid.
+  \retval false Move failed since the indexes were invalid.
 */
 //! @}
 /*!
-\name Retrieving items
+  \name Retrieving items
 */
 //! @{
 /*!
-\fn void *BList::ItemAt(int32 index) const
+  \fn void *BList::ItemAt(int32 index) const
-\brief Get an item.
+  \brief Get an item.
-\param index The item to retrieve.
+  \param index The item to retrieve.
-\return A pointer to the item in that position, or \c NULL if the index is out of bounds.
+  \return A pointer to the item in that position, or \c NULL if the index is
-\sa ItemAtFast(int32 index) const
+    out of bounds.
  \see ItemAtFast(int32 index) const
 */
 /*!
-\fn void *BList::FirstItem() const
+  \fn void *BList::FirstItem() const
-\brief Get the first item.
+  \brief Get the first item.
-\return A pointer to the first item, or \c NULL if the list is empty.
+  
  \return A pointer to the first item, or \c NULL if the list is empty.
 */
 /*!
-\fn void *BList::ItemAtFast(int32 index) const
+  \fn void *BList::ItemAtFast(int32 index) const
-\brief Get an item.
+  \brief Get an item.
-This method does not performs any boundary checks when it retrieves an item.
+  This method does not performs any boundary checks when it retrieves an item.
-Use this method in a performance critical area of your program where you are
+  Use this method in a performance critical area of your program where you are
-sure you won't get an invalid item.
+  sure you won't get an invalid item.
-\return A pointer to the item.
+  \return A pointer to the item.
 */
 /*!
-\fn void *BList::LastItem() const
+  \fn void *BList::LastItem() const
-\brief Get the last item.
+  \brief Get the last item.
-\return A pointer to the last item, or \c NULL if the list is empty.
+  \return A pointer to the last item, or \c NULL if the list is empty.
 */
 /*!
-\fn void *BList::Items() const
+  \fn void *BList::Items() const
-\brief Return the internal list of objects.
+  \brief Return the internal list of objects.
-This method will return a pointer to the internal pointer list. This means you should be careful
+  This method will return a pointer to the internal pointer list. This means
-what you are doing, since you are directly working with the internals of the class.
+  you should be careful   what you are doing, since you are directly working
  with the internals of the class.
-It is definately not a good idea to make any changes to the list, since it will mess up
+  It is definately not a good idea to make any changes to the list, since it
-the internal consistency. 
+  will mess up the internal consistency. 
-\warning If there is anything you want for which you need the list of objects, please
+  \warning If there is anything you want for which you need the list of
-  realize that that probably means that what you want to do is a bad idea to begin with.
+    objects, please realize that that probably means that what you want to do
-  Avoid this method. The list of objects doesn't belong to you. Check if DoForEach() can
+    is a bad idea to begin with. Avoid this method. The list of objects doesn't
-  help you.
+    belong to you. Check if DoForEach() can help you.
-\return The internal list of pointers.
+  \return The internal list of pointers.
 */
 //! @}
 /*!
-\name Querying for items
+  \name Querying for items
 */
 //! @{
 /*!
-\fn bool BList::HasItem(void *item) const
+  \fn bool BList::HasItem(void *item) const
-\brief Check if an item is in the list.
+  \brief Check if an item is in the list.
 */
 /*!
-\fn int32 BList::IndexOf(void *item) const
+  \fn int32 BList::IndexOf(void *item) const
-\brief Get the index of an item.
+  \brief Get the index of an item.
-\return The index of the item, or -1 when the item is not in the list.
+  \return The index of the item, or -1 when the item is not in the list.
 */
 /*!
-\fn int32 BList::CountItems() const
+  \fn int32 BList::CountItems() const
-\brief Get the number of items in the list.
+  \brief Get the number of items in the list.
 */
 /*!
-\fn bool BList::IsEmpty() const
+  \fn bool BList::IsEmpty() const
-\brief Check if there are items in the list.
+  \brief Check if there are items in the list.
 */
 //! @}
 /*!
-\name Iterating over the list
+  \name Iterating over the list
 */
 //! @{
 /*!
-\fn void BList::DoForEach(bool (*func)(void* item))
+  \fn void BList::DoForEach(bool (*func)(void* item))
-\brief Perform an action on every item in the list.
+  \brief Perform an action on every item in the list.
-If one of the actions on the items fails, meaning that the \c func function
+  If one of the actions on the items fails, meaning that the \a func function
-returned \c false, then the processing of the list will be stopped.
+  returned \c false, then the processing of the list will be stopped.
-\param func A function that takes a \c void * argument and returns a boolean.
+  \param func A function that takes a \c void * argument and returns a boolean.
 */
 /*!
-\fn void BList::DoForEach(bool (*func)(void* item, void* arg2), void *arg2)
+  \fn void BList::DoForEach(bool (*func)(void* item, void* arg2), void *arg2)
-\brief Perform an action on every item in the list with an argument.
+  \brief Perform an action on every item in the list with an argument.
-If one of the actions on the items fails, meaning that the \c func function
+  If one of the actions on the items fails, meaning that the \a func function
-returned \c false, then the processing of the list will be stopped.
+  returned \c false, then the processing of the list will be stopped.
-\param func A function with the first \c void * argument being the item,
+  \param func A function with the first \c void * argument being the item,
-  and the second \c void * being the argument that you supply. It should
+    and the second \c void * being the argument that you supply. It should
-  return a boolean value on whether it succeeded or not.
+    return a boolean value on whether it succeeded or not.
-\param arg2 An argument to supply to \c func.
+  \param arg2 An argument to supply to \a func.
 */
 //! @}