[haiku-commits] Re: haiku: hrev47428 - src/kits/app docs/user/app headers/os/app docs/user/support
- From: pulkomandy <pulkomandy@xxxxxxxxxxxxx>
- To: haiku-commits@xxxxxxxxxxxxx
- Date: Thu, 26 Jun 2014 08:05:57 +0200
> Please help me understand!
>
There are two guides to be generated from doxygen comments:
- One is the existing "Haiku Book" at api.haiku-os.org. It is intended
as an API guide for 3rd-party developers willing to write Haiku
applications. It is made from the doxygen files in docs/user, and the
doxygen comments in .h files.
- The other is not really existing yet, and is meant to be a
documentation of Haiku internals, for Haiku developers. IT would be
made of the files in docs/develop, and the doxygen comments in cpp
files. For example the app_server has its own doxyfile (in
docs/develop/server/app) and generated html files in that same
directory.
The idea is to keep the internal documentation in doxygen format in cpp
files, so we can generate this "haiku internals" book. This would work
in addition to the haiku book, so what we would need is:
- A short description of each method
- Possibly a link to the relevant haiku book description of the public
API
- Any useful notes on the internals, implementation, known bugs and
limitations and how they could be overcome
- And anything else that deserves to be documented but is irrelevant to
the API end-user.
This would include things such as BPicture internal storage format,
description of the app_server link protocol, documentation of app_server
internals, to name a few.
--
Adrien.
Other related posts:
