]> git.sur5r.net Git - openocd/commitdiff
doxygen: avoid most internals
authorDavid Brownell <dbrownell@users.sourceforge.net>
Mon, 2 Nov 2009 01:34:52 +0000 (17:34 -0800)
committerDavid Brownell <dbrownell@users.sourceforge.net>
Mon, 2 Nov 2009 01:34:52 +0000 (17:34 -0800)
For some reason, all the interals are documented by default.
This is wrong for two basic reasons:

 - We need to focus on public interfaces, since those are
   the architectural interfaces and relationships.

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

So don't expose so much by default.

Doxyfile.in

index 0b204a096b7304e819331d057989647355c1032a..038f1e556de389682995c266b38948b1f292901f 100644 (file)
@@ -307,13 +307,13 @@ 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.
 # If set to NO only classes defined in header files are included.
 
-EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_CLASSES  = NO
 
 # This flag is only useful for Objective-C code. When set to YES local
 # methods, which are defined in the implementation section but not in