Aren
/
haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21837 a95241bf-73f2-0310-859d-f6bbb57e9c96

This commit is contained in:
Niels Sascha Reedijk 2007-08-06 14:28:40 +00:00
parent e9d1494da3
commit 99b3aeed2d
4 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/user/apidoc.dox
View File

@ -3,9 +3,9 @@
* Distributed under the terms of the MIT License.
*
* Authors:
* Niels Sascha Reedijk, niels.reedijk@gmail.com
* Niels Sascha Reedijk, niels.reedijk@gmail.com
* Proofreaders:
* Alan Smale, ajsmale@gmail.com
* Alan Smale, ajsmale@gmail.com
*/
@ -15,7 +15,10 @@
This article explains how to document the API. Its intended audience are the
Haiku developers who want to document their own classes, and also the
members of the API Documentation team who want to brush up the
documentation.
documentation. The guidelines are synchronous with the Haiku Coding
Guidelines, which means that the formal requirements are the same where
applicable. If you find an inconsistency, it's usually a good idea to
report this on the documentation team's mailing list.
This document is divided into three sections. \ref formalrequirements
describes the demands that are made from the markup and spacing of the
@ -83,12 +86,12 @@
* Distributed under the terms of the MIT License.
*
* Authors:
* Niels Sascha Reedijk, niels.reedijk@gmail.com
* Niels Sascha Reedijk, niels.reedijk@gmail.com
* Proofreaders:
* Alan Smale, ajsmale@gmail.com
* Alan Smale, ajsmale@gmail.com
* Corresponds to:
* /trunk/headers/os/support/String.h rev 19731
* /trunk/src/kits/support/String.cpp rev 19731
* /trunk/headers/os/support/String.h rev 19731
* /trunk/src/kits/support/String.cpp rev 19731
*/
\endverbatim
@ -104,7 +107,7 @@
followed by an empty line.
-# Then there is a label <tt>Authors:</tt>, which is followed by
lines with names and email addresses. The latter one is optional, but
recommended.
recommended. Each author is preceeded by two tabs after the asterix.
-# In the same vein there is the label <tt>Proofreaders:</tt> in case the
file has been proofread.
-# The final part is underneath the label <tt>Corresponds to:</tt>.

10
docs/user/support/Archivable.dox
View File

@ -3,15 +3,15 @@
* Distributed under the terms of the MIT License.
*
* Author:
* Niels Sascha Reedijk, niels.reedijk@gmail.com
* Niels Sascha Reedijk, niels.reedijk@gmail.com
*
* Proofreader:
* David Weizades, ddewbofh@hotmail.com
* Thom Holwerda, slakje@quicknet.nl
* David Weizades, ddewbofh@hotmail.com
* Thom Holwerda, slakje@quicknet.nl
*
* Corresponds to:
* /trunk/headers/os/support/Archivable.h rev 19972
* /trunk/src/kits/support/Archivable.cpp rev 19095
* /trunk/headers/os/support/Archivable.h rev 19972
* /trunk/src/kits/support/Archivable.cpp rev 19095
*/

10
docs/user/support/BlockCache.dox
View File

@ -3,15 +3,15 @@
* Distributed under the terms of the MIT License.
*
* Authors:
* Niels Sascha Reedijk, niels.reedijk@gmail.com
* Niels Sascha Reedijk, niels.reedijk@gmail.com
*
* Proofreading:
* David Weizades, ddewbofh@hotmail.com
* Thom Holwerda, slakje@quicknet.nl
* David Weizades, ddewbofh@hotmail.com
* Thom Holwerda, slakje@quicknet.nl
*
* Corresponds to:
* /trunk/headers/os/support/BlockCache.h rev 19972
* /trunk/src/kits/support/BlockCache.cpp rev 4568
* /trunk/headers/os/support/BlockCache.h rev 19972
* /trunk/src/kits/support/BlockCache.cpp rev 4568
*/

12
docs/user/support/List.dox
View File

@ -3,16 +3,16 @@
* Distributed under the terms of the MIT License.
*
* Authors:
* Niels Sascha Reedijk, niels.reedijk@gmail.com
* Niels Sascha Reedijk, niels.reedijk@gmail.com
*
* Proofreading:
* David Weizades, ddewbofh@hotmail.com
* Thom Holwerda, slakje@quicknet.nl
* John Drinkwater, jdrinkwater@gmail.com
* David Weizades, ddewbofh@hotmail.com
* Thom Holwerda, slakje@quicknet.nl
* John Drinkwater, jdrinkwater@gmail.com
*
* Corresponds to:
* /trunk/headers/os/support/List.h rev 19972
* /trunk/src/kits/support/List.cpp rev 18649
* /trunk/headers/os/support/List.h rev 19972
* /trunk/src/kits/support/List.cpp rev 18649
*/