From 99b3aeed2d434ec8453b8c6d12f4aafaf001e551 Mon Sep 17 00:00:00 2001 From: Niels Sascha Reedijk Date: Mon, 6 Aug 2007 14:28:40 +0000 Subject: [PATCH] git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21837 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- docs/user/apidoc.dox | 19 +++++++++++-------- docs/user/support/Archivable.dox | 10 +++++----- docs/user/support/BlockCache.dox | 10 +++++----- docs/user/support/List.dox | 12 ++++++------ 4 files changed, 27 insertions(+), 24 deletions(-) diff --git a/docs/user/apidoc.dox b/docs/user/apidoc.dox index ace90d1257..b13e22439a 100644 --- a/docs/user/apidoc.dox +++ b/docs/user/apidoc.dox @@ -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 Authors:, 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 Proofreaders: in case the file has been proofread. -# The final part is underneath the label Corresponds to:. diff --git a/docs/user/support/Archivable.dox b/docs/user/support/Archivable.dox index 5204e83ca2..9396faf662 100644 --- a/docs/user/support/Archivable.dox +++ b/docs/user/support/Archivable.dox @@ -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 */ diff --git a/docs/user/support/BlockCache.dox b/docs/user/support/BlockCache.dox index 3e44079748..15d2f963e3 100644 --- a/docs/user/support/BlockCache.dox +++ b/docs/user/support/BlockCache.dox @@ -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 */ diff --git a/docs/user/support/List.dox b/docs/user/support/List.dox index a79c0d7b32..645129c70a 100644 --- a/docs/user/support/List.dox +++ b/docs/user/support/List.dox @@ -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 */