i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update the guidelines acording to the decisions during the meeting

Browse Source 
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21188 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Niels Sascha Reedijk
2007-05-21 15:45:39 +00:00
parent 2fb3526f33
commit de41d9ee27
1 changed files with 687 additions and 680 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/apidoc.dox
+15 -8
View File
@@ -2,8 +2,10 @@
* Copyright 2007 Haiku Inc. All rights reserved. * Copyright 2007 Haiku Inc. All rights reserved.
* Distributed under the terms of the MIT License. * Distributed under the terms of the MIT License.
* *
* Documentation by: * Authors:
* Niels Sascha Reedijk <[email protected]> * Niels Sascha Reedijk <[email protected]>
* Proofreaders:
* Alan Smale <[email protected]>
*/ */
/*! /*!
@@ -78,8 +80,10 @@
* Copyright 2007 Haiku Inc. All rights reserved. * Copyright 2007 Haiku Inc. All rights reserved.
* Distributed under the terms of the MIT License. * Distributed under the terms of the MIT License.
* *
* Documentation by: * Authors:
* Niels Sascha Reedijk <[email protected]> * Niels Sascha Reedijk <[email protected]>
* Proofreaders:
* Alan Smale <[email protected]>
* Corresponds to: * Corresponds to:
* /trunk/headers/os/support/String.h rev 19731 * /trunk/headers/os/support/String.h rev 19731
* /trunk/src/kits/support/String.cpp rev 19731 * /trunk/src/kits/support/String.cpp rev 19731
@@ -90,12 +94,14 @@
-# The header is put in a standard C comment, which is enclosed between -# The header is put in a standard C comment, which is enclosed between
\c /* and \c *\/. \c /* and \c *\/.
-# Every line starts with a whitespace and an asterix, followed by another -# Every line starts with a whitespace and an asterix, followed by another
space. If the text is part of a category, such as <tt>Documentation space. If the text is part of a category, such as <tt>Authors</tt>, put
by</tt>, put three spaces after the delimiter. three spaces after the delimiter.
-# We start with a copyright notice. The first line is empty, then the -# We start with a copyright notice. The first line is empty, then the
copyright notice, then the line on \e MIT, followed by an empty line. copyright notice, then the line on \e MIT, followed by an empty line.
-# Then there is a label <tt>Documentation by:</tt>, which is followed by -# Then there is a label <tt>Authors:</tt>, which is followed by
lines with names and email addresses between brackets. lines with names and email addresses between brackets.
-# 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>. -# The final part is underneath the label <tt>Corresponds to:</tt>.
Underneath there is a list of files and their svn revisions that the Underneath there is a list of files and their svn revisions that the
current documentation is known to correspond with. current documentation is known to correspond with.
@@ -518,8 +524,9 @@
of the kit or the API. What objects does it work with, how it interacts of the kit or the API. What objects does it work with, how it interacts
with the servers, etcetera. with the servers, etcetera.
-# One or more paragraphs that give a concrete example or use case. Keep it -# One or more paragraphs that give a concrete example or use case. Keep it
tidy and self contained. Remember, an example can illustrate better than a tidy and self contained. If you use code examples, make sure your examples
few paragraphs of text. adhere to Haiku's coding guidelines. Remember, an example can illustrate
better than a few paragraphs of text.
-# End with a list of references to other classes, functions, pages, etc. that -# End with a list of references to other classes, functions, pages, etc. that
might be of interest to the reader. might be of interest to the reader.