Comment 5 for bug 364267

Revision history for this message
Karsten Klagges (karsten.klagges) wrote :

I still have a different opinion:

The goal of the API documentation is to provide information about how to work with the API. Which means, there should be detailed information about what the intention of specific classes and their methods are. There can be information about method parameters and return values, typedefs and how components of the framework interact.

The API documentation should not explain how the implementation works or how a specific method is implemented. Actually this is not necessary to use the API.

If we decide to extract all classes from the source code, doxygen creates a webpage that contains the name of the class, the names of the member functions and all member variables. Even if the names are well chosen, the API user still would have to browse the source code which can easily be done in the IDE of your choice. In the end the purpose of the doxygen-documentation of undocumented class is at least questionable.

By the way. Launchpad provides a source code browser not only for the mainline of the openWNS but also for all branches. Do we need an additional source code browser in the API documentation?