mainpage.doxy: New.
2001-04-27 Benjamin Kosnik <bkoz@redhat.com> * docs/doxygen/mainpage.doxy: New. * docs/doxygen/user.cfg.in: Change default configuration. Single frame, other tweaks. From-SVN: r41648
This commit is contained in:
Benjamin Kosnik
Benjamin Kosnik
parent
16842c1535
commit
3f3942e851
|
|
@ -1,3 +1,9 @@
|
|||
2001-04-27 Benjamin Kosnik <bkoz@redhat.com>
|
||||
|
||||
* docs/doxygen/mainpage.doxy: New.
|
||||
* docs/doxygen/user.cfg.in: Change default configuration. Single
|
||||
frame, other tweaks.
|
||||
|
||||
2001-04-26 Mark Mitchell <mark@codesourcery.com>
|
||||
|
||||
* docs/html/17_intro/BADNAMES: Remove EGCS reference.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,62 @@
|
|||
/*! \mainpage
|
||||
|
||||
<h2> documentation overview </h2>
|
||||
|
||||
<p>
|
||||
There are two types of documentation for libstdc++-v3. One is the distribution documentation, which can be read
|
||||
<a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">here</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The other is the source documentation, of which this is the first page.
|
||||
</p>
|
||||
|
||||
<h2> generating this file </h2>
|
||||
<p>
|
||||
This page is automatically generated. The Makefile rule <tt>make
|
||||
doxygen</tt> in the libstdc++-v3 build directory generates these pages
|
||||
using a tool called, appropriately enough, doxygen. To learn more
|
||||
about doxygen, take a look at <a href="http://www.doxygen.org"> the
|
||||
doxygen webpage </a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The libstdc++-v3 configuration files needed to generate doxygen output
|
||||
are located:
|
||||
<p> <tt> docs/doxygen/user.cfg.in</tt> </p>
|
||||
<p> <tt> docs/doxygen/maint.cfg.in</tt> </p>
|
||||
</p>
|
||||
|
||||
<h2> libstdc++-v3 doxygen style guide </h2>
|
||||
<p>
|
||||
In general, libstdc++-v3 files should be formatted according to the
|
||||
GNU C++ Coding Standard rules found in the file <a
|
||||
href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</a>.
|
||||
Before any doxygen-specific formatting tweaks are made, please try to
|
||||
make sure that the initial formatting is sound.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The formatting guidelines for using libstdc++-v3 with doxygen are
|
||||
still incomplete. There seems to be a marginal preference for the use
|
||||
of Java-Doc style formatting, with the idea that the single-line style
|
||||
(triple-slash) is the least intrusive mechanism for getting
|
||||
libstdc++-v3 documented and cross-referenced while at the same time
|
||||
minimizing disruption to the current formatting.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
For the time being, please see <tt>include/bits/char_traits.h</tt>
|
||||
which is the test bed for a finished doxygen style guide.
|
||||
</p>
|
||||
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -16,13 +16,13 @@
|
|||
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
|
||||
# by quotes) that should identify the project.
|
||||
|
||||
PROJECT_NAME = "libstdc++"
|
||||
PROJECT_NAME = "libstdc++-v3"
|
||||
|
||||
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
|
||||
# This could be handy for archiving the generated documentation or
|
||||
# if some version control system is used.
|
||||
|
||||
PROJECT_NUMBER = 3
|
||||
PROJECT_NUMBER =
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
||||
# base path where the generated documentation will be put.
|
||||
|
|
@ -52,7 +52,7 @@ EXTRACT_ALL = YES
|
|||
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
|
||||
# will be included in the documentation.
|
||||
|
||||
EXTRACT_PRIVATE = NO
|
||||
EXTRACT_PRIVATE = YES
|
||||
|
||||
# If the EXTRACT_STATIC tag is set to YES all static members of a file
|
||||
# will be included in the documentation.
|
||||
|
|
@ -142,13 +142,13 @@ STRIP_CODE_COMMENTS = YES
|
|||
# in case and if your file system supports case sensitive file names. Windows
|
||||
# users are adviced to set this option to NO.
|
||||
|
||||
CASE_SENSE_NAMES = YES
|
||||
CASE_SENSE_NAMES = NO
|
||||
|
||||
# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
|
||||
# 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 = YES
|
||||
HIDE_SCOPE_NAMES = NO
|
||||
|
||||
# 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 = NO
|
||||
SHOW_INCLUDE_FILES = YES
|
||||
|
||||
# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
|
||||
# will interpret the first line (until the first dot) of a JavaDoc-style
|
||||
|
|
@ -186,14 +186,14 @@ INLINE_INFO = YES
|
|||
# alphabetically by member name. If set to NO the members will appear in
|
||||
# declaration order.
|
||||
|
||||
SORT_MEMBER_DOCS = NO
|
||||
SORT_MEMBER_DOCS = YES
|
||||
|
||||
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
|
||||
# tag is set to YES, then doxygen will reuse the documentation of the first
|
||||
# member in the group (if any) for the other members of the group. By default
|
||||
# all members of a group must be documented explicitly.
|
||||
|
||||
#DISTRIBUTE_GROUP_DOC = NO
|
||||
DISTRIBUTE_GROUP_DOC = NO
|
||||
|
||||
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
|
||||
# Doxygen uses this value to replace tabs by spaces in code fragments.
|
||||
|
|
@ -270,14 +270,14 @@ WARN_FORMAT = "$file:$line: $text"
|
|||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
INPUT = include src
|
||||
INPUT = docs/doxygen libsupc++ include src
|
||||
|
||||
# If the value of the INPUT tag contains directories, you can use the
|
||||
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
|
||||
# and *.h) to filter out the source-files in the directories. If left
|
||||
# blank all files are included.
|
||||
|
||||
FILE_PATTERNS = *.cc *.h c++config
|
||||
FILE_PATTERNS = *.doxy *.cc *.tcc *.h c++config
|
||||
|
||||
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
|
||||
# should be searched for input files as well. Possible values are YES and NO.
|
||||
|
|
@ -288,7 +288,7 @@ RECURSIVE = YES
|
|||
# The EXCLUDE tag can be used to specify files and/or directories that should
|
||||
# excluded from the INPUT source files. This way you can easily exclude a
|
||||
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
||||
EXCLUDE =
|
||||
EXCLUDE = include/c include/c_shadow
|
||||
|
||||
# If the value of the INPUT tag contains directories, you can use the
|
||||
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
||||
|
|
@ -417,7 +417,7 @@ DISABLE_INDEX = NO
|
|||
# JavaScript and frames is required (for instance Netscape 4.0+
|
||||
# or Internet explorer 4.0+).
|
||||
|
||||
GENERATE_TREEVIEW = YES
|
||||
GENERATE_TREEVIEW = NO
|
||||
|
||||
# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
|
||||
# used to set the initial width (in pixels) of the frame in which the tree
|
||||
|
|
@ -738,3 +738,5 @@ EXT_DOC_PATHS =
|
|||
|
||||
# End of file
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue