For some reason, all the interals are documented by default.
This seems wrong for two basic reasons:

 - We need to focus on public interfaces, since they're the
   ones that expose the architectural relationships.

 - Since virtually nothing has doxygen support yet, this
   just maximizes the amount of noise, and minimizes the
   usefulness of the doxygen output.

Objections if I merge this?  Of course, anyone who *wants* to
see internals can turn this knob the other way.  I'm just saying
the default is wrong ... if folk want to use this output to help
learn how things fit together, they need a *less* information
not more, and it needs to be at a higher level.


--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -307,7 +307,7 @@ EXTRACT_PRIVATE        = NO
 # If the EXTRACT_STATIC tag is set to YES all static members of a file
 # will be included in the documentation.
 
-EXTRACT_STATIC         = YES
+EXTRACT_STATIC         = NO
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
 # defined locally in source files will be included in the documentation.

_______________________________________________
Openocd-development mailing list
Openocd-development@lists.berlios.de
https://lists.berlios.de/mailman/listinfo/openocd-development

Reply via email to