GSoC/GCI Archive
Google Code-in 2013 Haiku

Document a class in the API documentation

completed by: hometue

mentors: jscipione, Emrys Demir

Document a class in the API documentation aka the "Haiku Book".


This task involves reading and understanding a single class in the Haiku API and then documenting the class, each public and protected method in the class, each parameters and return values, also, you must describe the functionality provided by the class, also document any supporting data structures.


Knowledge of technical writing, a bit of doxygen syntax, and the ability to read but not write C++ code is required to complete this task.


It realistically takes around 1-4 hours of time to complete this task depending on how big the class is and how many methods it has.