mirror of
git://gcc.gnu.org/git/gcc.git
synced 2024-12-23 00:29:45 +08:00
729e3d3f01
2001-11-02 Phil Edwards <pme@gcc.gnu.org> * config/io/c_io_stdio.h: Correct grammar in comments. * docs/doxygen/Intro.3: Expand "top-level" man page. * docs/doxygen/doxygroups.cc: New module definitions (comments). * docs/doxygen/mainpage.doxy: Tweaks. * docs/doxygen/run_doxygen: Update Doxygen version, massage man pages. Add @file hooks so that headers are considered to be documented. * include/bits/basic_ios.h, include/bits/basic_file.h, include/bits/basic_string.h, include/bits/boost_concept_check.h, include/bits/char_traits.h, include/bits/codecvt.h, include/bits/concept_check.h, include/bits/cpp_type_traits.h, include/bits/fpos.h, include/bits/gslice.h, include/bits/gslice_array.h, include/bits/indirect_array.h, include/bits/ios_base.h, include/bits/locale_facets.h, include/bits/localefwd.h, include/bits/mask_array.h, include/bits/pthread_allocimpl.h, include/bits/slice.h, include/bits/slice_array.h, include/bits/std_algorithm.h, include/bits/std_bitset.h, include/bits/std_complex.h, include/bits/std_deque.h, include/bits/std_fstream.h, include/bits/std_functional.h, include/bits/std_iomanip.h, include/bits/std_ios.h, include/bits/std_iosfwd.h, include/bits/std_iostream.h, include/bits/std_istream.h, include/bits/std_iterator.h, include/bits/std_limits.h, include/bits/std_list.h, include/bits/std_locale.h, include/bits/std_map.h, include/bits/std_memory.h, include/bits/std_numeric.h, include/bits/std_ostream.h, include/bits/std_queue.h, include/bits/std_set.h, include/bits/std_sstream.h, include/bits/std_stack.h, include/bits/std_streambuf.h, include/bits/std_string.h, include/bits/std_utility.h, include/bits/std_valarray.h, include/bits/std_vector.h, include/bits/stl_algo.h, include/bits/stl_alloc.h, include/bits/stl_bvector.h, include/bits/stl_construct.h, include/bits/stl_deque.h, include/bits/stl_heap.h, include/bits/stl_iterator.h, include/bits/stl_iterator_base_funcs.h, include/bits/stl_iterator_base_types.h, include/bits/stl_list.h, include/bits/stl_map.h, include/bits/stl_multimap.h, include/bits/stl_multiset.h, include/bits/stl_numeric.h, include/bits/stl_pair.h, include/bits/stl_pthread_alloc.h, include/bits/stl_queue.h, include/bits/stl_raw_storage_iter.h, include/bits/stl_relops.h, include/bits/stl_set.h, include/bits/stl_stack.h, include/bits/stl_tempbuf.h, include/bits/stl_threads.h, include/bits/stl_tree.h, include/bits/stl_uninitialized.h, include/bits/stl_vector.h, include/bits/stream_iterator.h, include/bits/streambuf_iterator.h, include/bits/stringfwd.h, include/bits/type_traits.h, include/bits/valarray_array.h, include/bits/valarray_meta.h: Add hooks, tweak comments only. * include/bits/stl_algobase.h (swap, min, iter_swap): Also document these functions. * include/bits/stl_function.h: Tweak link comments. From-SVN: r46717
77 lines
2.9 KiB
Plaintext
77 lines
2.9 KiB
Plaintext
/*! \mainpage
|
|
|
|
<h2> Documentation Overview </h2>
|
|
|
|
<p>There are two types of documentation for libstdc++-v3. One is the
|
|
distribution documentation, which can be read online at
|
|
<a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html</a>
|
|
or offline from docs/html/documentation.html in the library source
|
|
directory.
|
|
</p>
|
|
|
|
<p>The other type is the source documentation, of which this is the first page.
|
|
Here are quick links to the pages which we seem to use the most; a full
|
|
index is at the bottom:
|
|
<!-- Keep this in sync with below. -->
|
|
<ul>
|
|
<li><a href="annotated.html">Compound List</a>
|
|
<li><a href="classes.html">Alphabetical List</a>
|
|
<li><a href="files.html">File List</a>
|
|
<li><a href="modules.html">Modules</a>
|
|
</ul>
|
|
</p>
|
|
|
|
<h2> Generating this file </h2>
|
|
<p>These HTML pages are automatically generated, along with the man pages.
|
|
The Makefile rule <code> 'make
|
|
doxygen' </code> 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:
|
|
<ul><li><code>docs/doxygen/user.cfg.in</code>
|
|
<li><code>docs/doxygen/maint.cfg.in</code>
|
|
</ul>
|
|
</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. Full documentation of functions
|
|
(parameter types, return values, etc) will require the slash-splat-splat
|
|
"extended C" commenting style.
|
|
</p>
|
|
|
|
<h2> Full page index </h2>
|
|
<p>Here are entry points to all the pages generated by Doxygen:
|
|
<ul>
|
|
<li><a href="index.html">Main Page</a>
|
|
<li><a href="modules.html">Modules</a>
|
|
<li><a href="namespaces.html">Namespace List</a>
|
|
<li><a href="hierarchy.html">Class Hierarchy</a>
|
|
<li><a href="classes.html">Alphabetical List</a>
|
|
<li><a href="annotated.html">Compound List</a>
|
|
<li><a href="files.html">File List</a>
|
|
<li><a href="namespacemembers.html">Namespace Members</a>
|
|
<li><a href="functions.html">Compound Members</a>
|
|
<li><a href="globals.html">File Members</a>
|
|
</ul>
|
|
</p>
|
|
|
|
*/
|
|
|
|
|