Document one method for the Haiku Book
completed by: Markus Himmel (TwoFx)
mentors: mmu_man, Adrien Destugues - PulkoMandy, Richard Nyhus-Smith
The Haiku book (http://api.haiku-os.org) is the documentation for Haiku public APIs. It replaces and complements the Be book which was the same for BeOS. Work on the Haiku Book is not complete, and many classes are missing from it.
The goal of this task is to write documentation for one method for the Haiku book. Pick one method that is part of the public API (anything in /system/develop/headers/os) and write documentation for it. Your work must follow the guidelines at http://api.haiku-os.org/apidoc.html and use the Doxygen format.
You can pick one method from the public API without constraints.