Comment 7 for bug 364267

Revision history for this message
Daniel Bültmann (daniel.bueltmann) wrote :

We had a discussion on this topic offline this morning. We came to the agreement that we should extract all classes and namespaces regardless of whether they are documented or not. We also decided to include the source code in the API documentation. The reasons for this decision are:

 1. Although it would be nice to hide implementation details and internals in the documentation, we don't have the information available what is an import public class and what is an internal.
 2. Because we have a quite low documentation coverage simply dropping all undocumented classes is not an option.
 3. The source code is also included. We assume that not all users have a IDE running. Understanding an implementation means that you need to understand the semantic dependencies between parts of the implementation. Doxygen offers you to explore these dependencies.
  3b. You can browse the openWNS source code "offline" without having a local copy of the source code.

I reverted the changes and also did some cleanup on the documentation build process. I will commit the patch today.