mainpage.html: Bring up to date.
2003-04-29 Phil Edwards <pme@gcc.gnu.org> * docs/doxygen/mainpage.html: Bring up to date. * docs/doxygen/run_doxygen: Cosmetic tweaks. Work around a bug in Doxygen. * docs/doxygen/user.cfg.in: Scanning the precompiled headers breaks everything. Don't scan them. * docs/html/documentation.html: Point to "Write after approval" notes. From-SVN: r66270
This commit is contained in:
parent
b3d627e251
commit
e1bff39ade
5 changed files with 30 additions and 17 deletions
|
@ -1,3 +1,13 @@
|
||||||
|
2003-04-29 Phil Edwards <pme@gcc.gnu.org>
|
||||||
|
|
||||||
|
* docs/doxygen/mainpage.html: Bring up to date.
|
||||||
|
* docs/doxygen/run_doxygen: Cosmetic tweaks. Work around a bug
|
||||||
|
in Doxygen.
|
||||||
|
* docs/doxygen/user.cfg.in: Scanning the precompiled headers
|
||||||
|
breaks everything. Don't scan them.
|
||||||
|
* docs/html/documentation.html: Point to "Write after approval"
|
||||||
|
notes.
|
||||||
|
|
||||||
2003-04-29 Phil Edwards <pme@gcc.gnu.org>
|
2003-04-29 Phil Edwards <pme@gcc.gnu.org>
|
||||||
|
|
||||||
* acinclude.m4 (GLIBCPP_ENABLE_CLOCALE): Search for gettext outside
|
* acinclude.m4 (GLIBCPP_ENABLE_CLOCALE): Search for gettext outside
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
|
|
||||||
<h1>libstdc++-v3 Source Documentation</h1>
|
<h1>libstdc++-v3 Source Documentation</h1>
|
||||||
|
|
||||||
<h2> Documentation Overview </h2>
|
<h2>Documentation Overview</h2>
|
||||||
|
|
||||||
<p class="smallertext">@LEVEL@-level docs, generated @DATE@.</p>
|
<p class="smallertext">@LEVEL@-level docs, generated @DATE@.</p>
|
||||||
|
|
||||||
|
@ -48,6 +48,7 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="annotated.html">Compound List</a>
|
<li><a href="annotated.html">Compound List</a>
|
||||||
<li><a href="classes.html">Alphabetical List</a>
|
<li><a href="classes.html">Alphabetical List</a>
|
||||||
|
<li><a href="namespaces.html">Namespace List</a>
|
||||||
<li><a href="files.html">File List</a>
|
<li><a href="files.html">File List</a>
|
||||||
<li><a href="modules.html">Modules</a>
|
<li><a href="modules.html">Modules</a>
|
||||||
</ul>
|
</ul>
|
||||||
|
@ -81,16 +82,6 @@ href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</a>.
|
||||||
make sure that the initial formatting is sound.
|
make sure that the initial formatting is sound.
|
||||||
</p>
|
</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>
|
<h2> Full page index </h2>
|
||||||
<p>Here are entry points to all the pages generated by Doxygen:
|
<p>Here are entry points to all the pages generated by Doxygen:
|
||||||
<ul>
|
<ul>
|
||||||
|
|
|
@ -131,7 +131,6 @@ test $do_man = yes && {
|
||||||
chmod -R u+w $outdir/man/man3/ext
|
chmod -R u+w $outdir/man/man3/ext
|
||||||
}
|
}
|
||||||
|
|
||||||
set -e
|
|
||||||
(
|
(
|
||||||
set -e
|
set -e
|
||||||
cd $builddir
|
cd $builddir
|
||||||
|
@ -147,13 +146,15 @@ set -e
|
||||||
$doxygen ${outdir}/${mode}.cfg
|
$doxygen ${outdir}/${mode}.cfg
|
||||||
echo :: Finished, exit code was $?
|
echo :: Finished, exit code was $?
|
||||||
)
|
)
|
||||||
set +e
|
ret=$?
|
||||||
|
test $ret -ne 0 && exit $ret
|
||||||
|
|
||||||
test $do_html = yes && {
|
test $do_html = yes && {
|
||||||
|
cd ${outdir}/html_${mode}
|
||||||
sed -e "s=@LEVEL@=${LEVELtext}=" \
|
sed -e "s=@LEVEL@=${LEVELtext}=" \
|
||||||
-e "s=@DATE@=${DATEtext}=" \
|
-e "s=@DATE@=${DATEtext}=" \
|
||||||
${srcdir}/docs/doxygen/mainpage.html > ${outdir}/html_${mode}/index.html
|
${srcdir}/docs/doxygen/mainpage.html > index.html
|
||||||
cd ${outdir}/html_${mode}
|
|
||||||
# The following bit of line noise changes annoying
|
# The following bit of line noise changes annoying
|
||||||
# std::foo < typename _Ugly1, typename _Ugly2, .... _DefaultUgly17 >
|
# std::foo < typename _Ugly1, typename _Ugly2, .... _DefaultUgly17 >
|
||||||
# to user-friendly
|
# to user-friendly
|
||||||
|
@ -161,6 +162,13 @@ test $do_html = yes && {
|
||||||
# in the major "Compound List" page.
|
# in the major "Compound List" page.
|
||||||
sed -e 's=\(::[[:alnum:]_]*\)< .* >=\1=' annotated.html > annstrip.html
|
sed -e 's=\(::[[:alnum:]_]*\)< .* >=\1=' annotated.html > annstrip.html
|
||||||
mv annstrip.html annotated.html
|
mv annstrip.html annotated.html
|
||||||
|
|
||||||
|
# Work around a bug in doxygen 1.3.
|
||||||
|
for f in class*html struct*html; do
|
||||||
|
sed '1,10s!^<title> Template!<title>Template !' $f > TEMP
|
||||||
|
mv TEMP $f
|
||||||
|
done
|
||||||
|
|
||||||
cp ${srcdir}/docs/doxygen/tables.html tables.html
|
cp ${srcdir}/docs/doxygen/tables.html tables.html
|
||||||
echo ::
|
echo ::
|
||||||
echo :: HTML pages begin with
|
echo :: HTML pages begin with
|
||||||
|
|
|
@ -383,7 +383,8 @@ RECURSIVE = YES
|
||||||
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
# subdirectory from a directory tree whose root is specified with the INPUT tag.
|
||||||
|
|
||||||
EXCLUDE = Makefile \
|
EXCLUDE = Makefile \
|
||||||
CVS
|
CVS \
|
||||||
|
stdc++.h.gch
|
||||||
|
|
||||||
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
|
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
|
||||||
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
|
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
|
||||||
|
@ -396,7 +397,8 @@ EXCLUDE_SYMLINKS = NO
|
||||||
|
|
||||||
EXCLUDE_PATTERNS = CVS \
|
EXCLUDE_PATTERNS = CVS \
|
||||||
stamp-* \
|
stamp-* \
|
||||||
Makefile
|
Makefile \
|
||||||
|
*gch*
|
||||||
|
|
||||||
# The EXAMPLE_PATH tag can be used to specify one or more files or
|
# The EXAMPLE_PATH tag can be used to specify one or more files or
|
||||||
# directories that contain example code fragments that are included (see
|
# directories that contain example code fragments that are included (see
|
||||||
|
|
|
@ -237,6 +237,8 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="17_intro/contribute.html">Contributor checklist</a></li>
|
<li><a href="17_intro/contribute.html">Contributor checklist</a></li>
|
||||||
<li><a href="17_intro/libstdc++-assign.txt">Copyright assignment form for libstdc++-v3</a></li>
|
<li><a href="17_intro/libstdc++-assign.txt">Copyright assignment form for libstdc++-v3</a></li>
|
||||||
|
<li><a href="http://gcc.gnu.org/cvswrite.html">Getting CVS write access
|
||||||
|
(look for "Write after approval")</a></li>
|
||||||
<li><a href="17_intro/BADNAMES">BADNAMES</a>
|
<li><a href="17_intro/BADNAMES">BADNAMES</a>
|
||||||
- names to avoid because of potential collisions</li>
|
- names to avoid because of potential collisions</li>
|
||||||
<li><a href="17_intro/C++STYLE">C++STYLE</a>
|
<li><a href="17_intro/C++STYLE">C++STYLE</a>
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue