Changes between Initial Version and Version 1 of Obsolete/ApiDocumentationStatus


Ignore:
Timestamp:
May 21, 2007, 11:38:21 AM (17 years ago)
Author:
nielx
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Obsolete/ApiDocumentationStatus

    v1 v1  
     1= API Documentation Status Page =
     2This is a status page for the [http://haiku-os.org/about/teams/documentation API documentation team]. It is intended to be an overview of the current status of the files.
     3
     4If you are interested in helping out with the API documentation, you should start with [http://haiku-os.org/documents/dev/haiku_documentation_team_how_to setting up your environment], and sending a message on the [http://www.freelists.org/list/haiku-doc mailing list].
     5
     6One word of warning (which cannot be repeated enough), if you are writing documentation for Haiku, you are '''absolutely forbidden to have a look at the BeBook''' in order to prevent any intentional or unintentional copyright infringements.
     7
     8== Workings of this page ==
     9The documentation of Haiku's API is a three phase process. Every header file or additional documentation pages go through all the phases, where every phase is completed by a different person.
     10
     11 1. The technical documentation needs to be written. This is the most intense phase. Based on the source, on notes on the [http://haiku-os.org/ Haiku website] and help from the developer, the __initial version__ of the documentation will be written.
     12 1. After this, there will be a round of __technical proofreading__, where one of the peers checks if all the documentation is formally correct (in complience with the [http://factory.haiku-os.org/documentation/Haiku_Book_doxygen/html/apidoc.html API documentation guidelines]) and if the content is correct (does the documentation indeed say what it actually does).
     13 1. The final phase is the __spelling and grammar check__ by someone with a (near-)native level of English.
     14
     15This page provides a listing of all the files, and which phase it is in. This page is meant as an overview. If you actually want to claim a task, you should send an e-mail to the mailing list on which task you are going to perform, and you should update this page. In case of any confusion that might rise, the mailing list has precendence over this status page.
     16
     17Claims for tasks are valid for up to ''two weeks'' until the last sign of life on the mailing list. If you are unable to perform a claimed task, please be so kind to free it for someone else to pick up.
     18
     19== Support Kit Overview ==
     20
     21{{{
     22#!html
     23<table>
     24  <tr><th>File</th><th>Phase I</th><th>Phase II</th><th>Phase III</th></tr>
     25  <tr>
     26    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/Archivable.dox?rev=20724&view=log">Archivable.dox</a></td>
     27    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     28    <td style="background-color: red;">&nbsp;</td>
     29    <td style="background-color: red;">&nbsp;</td>
     30  </tr>
     31  <tr>
     32    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/Beep.dox?rev=20724&view=log">Beep.dox</a></td>
     33    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     34    <td style="background-color: red;">&nbsp;</td>
     35    <td style="background-color: red;">&nbsp;</td>
     36  </tr>
     37  <tr>
     38    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/BlockCache.dox?rev=20724&view=log">BlockCache.dox</a></td>
     39    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     40    <td style="background-color: red;">&nbsp;</td>
     41    <td style="background-color: red;">&nbsp;</td>
     42  </tr>
     43  <tr>
     44    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/BufferIO.dox?rev=20511&view=log">BufferIO.dox</a></td>
     45    <td style="background-color: green;">Niels Sascha Reedijk - 04-02-2007</td>
     46    <td style="background-color: red;">&nbsp;</td>
     47    <td style="background-color: red;">&nbsp;</td>
     48  </tr>
     49  <tr>
     50    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/DataIO.dox?rev=20511&view=log">DataIO.dox</a></td>
     51    <td style="background-color: green;">Niels Sascha Reedijk - 04-02-2007</td>
     52    <td style="background-color: red;">&nbsp;</td>
     53    <td style="background-color: red;">&nbsp;</td>
     54  </tr>
     55  <tr>
     56    <td>Debug.dox</td>
     57    <td style="background-color: red;">&nbsp;</td>
     58    <td style="background-color: red;">&nbsp;</td>
     59    <td style="background-color: red;">&nbsp;</td>
     60  </tr>
     61  <tr>
     62    <td>Errors.dox</td>
     63    <td style="background-color: red;"></td>
     64    <td style="background-color: red;">&nbsp;</td>
     65    <td style="background-color: red;">&nbsp;</td>
     66  </tr>
     67  <tr>
     68    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/Flattenable.dox?rev=20511&view=log">Flattenable.dox</a></td>
     69    <td style="background-color: green;">Niels Sascha Reedijk - 04-02-2007</td>
     70    <td style="background-color: red;">&nbsp;</td>
     71    <td style="background-color: red;">&nbsp;</td>
     72  </tr>
     73  <tr>
     74    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/List.dox?rev=20724&view=log">List.dox</a></td>
     75    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     76    <td style="background-color: orange;">David Weizades - 05-18-2007</td>
     77    <td style="background-color: red;">&nbsp;</td>
     78  </tr>
     79  <tr>
     80    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/Locker.dox?rev=20511&view=log">Locker.dox</a></td>
     81    <td style="background-color: green;">Niels Sascha Reedijk - 04-02-2007</td>
     82    <td style="background-color: red;">&nbsp;</td>
     83    <td style="background-color: red;">&nbsp;</td>
     84  </tr>
     85  <tr>
     86    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/SupportDefs.dox?rev=20724&view=log">SupportDefs.dox</a></td>
     87    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     88    <td style="background-color: red;">&nbsp;</td>
     89    <td style="background-color: red;">&nbsp;</td>
     90  </tr>
     91  <tr>
     92    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/parsedate.dox?rev=20724&view=log">parsedate.dox</a></td>
     93    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     94    <td style="background-color: red;">&nbsp;</td>
     95    <td style="background-color: red;">&nbsp;</td>
     96  </tr>
     97  <tr>
     98    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/stopwatch.dox?rev=20724&view=log">Stopwatch.dox</a></td>
     99    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     100    <td style="background-color: red;">&nbsp;</td>
     101    <td style="background-color: red;">&nbsp;</td>
     102  </tr>
     103  <tr>
     104    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/string.dox?rev=20724&view=log">String.dox</a></td>
     105    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     106    <td style="background-color: red;">&nbsp;</td>
     107    <td style="background-color: red;">&nbsp;</td>
     108  </tr>
     109  <tr>
     110    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/support_intro.dox?rev=20724&view=log">support_intro.dox</a></td>
     111    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     112    <td style="background-color: red;">&nbsp;</td>
     113    <td style="background-color: red;">&nbsp;</td>
     114  </tr>
     115  <tr>
     116    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/syslog.dox?rev=20724&view=log">syslog.dox</a></td>
     117    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     118    <td style="background-color: red;">&nbsp;</td>
     119    <td style="background-color: red;">&nbsp;</td>
     120  </tr>
     121  <tr>
     122    <td>TLS.dox</td>
     123    <td style="background-color: red;">&nbsp;</td>
     124    <td style="background-color: red;">&nbsp;</td>
     125    <td style="background-color: red;">&nbsp;</td>
     126  </tr>
     127  <tr>
     128    <td><a href="http://svn.berlios.de/viewcvs/haiku/haiku/trunk/docs/user/support/typeconstants.dox?rev=20724&view=log">TypeConstants.dox</a></td>
     129    <td style="background-color: green;">Niels Sascha Reedijk - 04-16-2007</td>
     130    <td style="background-color: red;">&nbsp;</td>
     131    <td style="background-color: red;">&nbsp;</td>
     132  </tr>
     133  <tr>
     134    <td>UTF8.dox</td>
     135    <td style="background-color: red;">&nbsp;</td>
     136    <td style="background-color: red;">&nbsp;</td>
     137    <td style="background-color: red;">&nbsp;</td>
     138  </tr>
     139</table>
     140}}}