Version 4 (modified by nielx, 12 years ago) (diff)


API Documentation Status Page

This is a status page for the API documentation team. It is intended to be an overview of the current status of the files.

If you are interested in helping out with the API documentation, you should start with setting up your environment, and sending a message on the mailing list.

One 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.

Workings of this page

The 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.

  1. The technical documentation needs to be written. This is the most intense phase. Based on the source, on notes on the Haiku website and help from the developer, the initial version of the documentation will be written.
  2. 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 API documentation guidelines) and if the content is correct (does the documentation indeed say what it actually does).
  3. The final phase is the spelling and grammar check by someone with a (near-)native level of English.

This 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, keep in mind the following guidelines:

  1. 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.
  2. Claims 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.
  3. Claims for a certain phase can only be made if the one of the previous phase is completed.

Example overview table:

FilePhase IPhase IIPhase III
Archivable.dox Niels Sascha Reedijk - 04-16-2007 Piet Paulusma - 04-20-2007  
  • The filename is linked to the log that is in ViewSVN on Berlios.
  • The background color for an open tasks is red.
  • The background color for a task in progress is orange.
  • A finished task has the green background.
  • The dates behind the names are in case of a claimed task, the date of the claim, and in case of a finished task, the date of checkin (which should be updated by the person who checked the change in).

Driver Overview

FilePhase IPhase IIPhase III
USB3.dox Niels Sascha Reedijk - 05-17-2007 Michael Lotz - 05-18-2007 - unconfirmed  
USB_spec.dox Niels Sascha Reedijk - 05-17-2007 Michael Lotz - 05-18-2007 - unconfirmed  
fs_interface.dox Ingo Weinhold - 04-04-2007    
  Niels Sascha Reedijk - 05-21-2007
fs_modules.dox Ingo Weinhold - 04-04-2007    
  Niels Sascha Reedijk - 05-21-2007
usb_modules.dox Niels Sascha Reedijk - 05-17-2007 Michael Lotz - 05-18-2007 - unconfirmed  

Support Kit Overview

FilePhase IPhase IIPhase III
Archivable.dox Niels Sascha Reedijk - 04-16-2007    
Beep.dox Niels Sascha Reedijk - 04-16-2007    
BlockCache.dox Niels Sascha Reedijk - 04-16-2007    
BufferIO.dox Niels Sascha Reedijk - 04-02-2007    
DataIO.dox Niels Sascha Reedijk - 04-02-2007    
Flattenable.dox Niels Sascha Reedijk - 04-02-2007    
List.dox Niels Sascha Reedijk - 04-16-2007 David Weizades - 05-18-2007  
Locker.dox Niels Sascha Reedijk - 04-02-2007    
SupportDefs.dox Niels Sascha Reedijk - 04-16-2007    
parsedate.dox Niels Sascha Reedijk - 04-16-2007    
Stopwatch.dox Niels Sascha Reedijk - 04-16-2007    
String.dox Niels Sascha Reedijk - 04-16-2007    
support_intro.dox Niels Sascha Reedijk - 04-16-2007    
syslog.dox Niels Sascha Reedijk - 04-16-2007    
TLS.dox Niels Sascha Reedijk - 05-22-2007    
TypeConstants.dox Niels Sascha Reedijk - 04-16-2007