This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
[v3] doxygen tweaks
- To: libstdc++ at gcc dot gnu dot org, gcc-patches at gcc dot gnu dot org
- Subject: [v3] doxygen tweaks
- From: Phil Edwards <pedwards at disaster dot jaj dot com>
- Date: Wed, 4 Apr 2001 18:34:47 -0400
This starts treating the "user" documentation as the only documentation;
we'll leave it that way until we actually have a need to break off
maintainer-only information.
"make doxygen" will actually generate some results with this patch.
Actually, that's an understatement; it generates a lot. Please give this
a try and throw out some suggestions. [v3'ers please trim gcc-patches
from the headers if we start hefty discussions from this]
(I need a tool that deletes unreferenced files once they are no longer
linked-to from an HTML file. That would help manage the not-as-useful
stuff.)
Applied to trunk.
Phil
2001-04-04 Phil Edwards <pme@sources.redhat.com>
* docs/doxygen/user.cfg.in: Extract all non-private members;
reduce confusing documentation output.
Index: docs/doxygen/user.cfg.in
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/doxygen/user.cfg.in,v
retrieving revision 1.1
diff -u -3 -p -r1.1 user.cfg.in
--- user.cfg.in 2001/03/25 02:28:07 1.1
+++ user.cfg.in 2001/04/04 22:13:08
@@ -46,8 +46,8 @@ OUTPUT_LANGUAGE = English
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-EXTRACT_ALL = NO
-#EXTRACT_ALL = YES
+#EXTRACT_ALL = NO
+EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
@@ -86,7 +86,7 @@ BRIEF_MEMBER_DESC = NO
# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
-REPEAT_BRIEF = YES
+REPEAT_BRIEF = NO
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# Doxygen will generate a detailed section even if there is only a brief
@@ -148,7 +148,7 @@ CASE_SENSE_NAMES = YES
# will show members with their full class and namespace scopes in the
# documentation. If set to YES the scope will be hidden.
-HIDE_SCOPE_NAMES = NO
+HIDE_SCOPE_NAMES = YES
# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
# will generate a verbatim copy of the header file for each class for
@@ -160,7 +160,7 @@ VERBATIM_HEADERS = NO
# will put list of the files that are included by a file in the documentation
# of that file.
-SHOW_INCLUDE_FILES = YES
+SHOW_INCLUDE_FILES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
# will interpret the first line (until the first dot) of a JavaDoc-style