This is the mail archive of the libstdc++@gcc.gnu.org mailing list for the libstdc++ project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[libstdc++] documentation tweak


The doxygen change just cleans up the generated names displayed on the
"Compound List" page.

The other changes are XHTML fixes.


2002-07-17  Phil Edwards  <pme@gcc.gnu.org>

	* docs/doxygen/run_doxygen:  Remove template parameter names from
	"Compound List" summary page.  Reformat.
	* docs/html/documentation.html:  XHTML fixes.


Index: docs/doxygen/run_doxygen
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/doxygen/run_doxygen,v
retrieving revision 1.16
diff -u -3 -p -r1.16 run_doxygen
--- docs/doxygen/run_doxygen	18 Apr 2002 01:42:49 -0000	1.16
+++ docs/doxygen/run_doxygen	17 Jul 2002 22:01:15 -0000
@@ -150,13 +150,16 @@ set -e
 set +e
 
 test $do_html = yes && {
-    sed -e "s=@LEVEL@=${LEVELtext}=" \
-        -e "s=@DATE@=${DATEtext}=" \
-        ${srcdir}/docs/doxygen/mainpage.html > ${outdir}/html_${mode}/index.html
-    cp ${srcdir}/docs/doxygen/tables.html ${outdir}/html_${mode}/tables.html
-    echo ::
-    echo :: HTML pages begin with
-    echo :: ${outdir}/html_${mode}/index.html
+  sed -e "s=@LEVEL@=${LEVELtext}=" \
+      -e "s=@DATE@=${DATEtext}=" \
+      ${srcdir}/docs/doxygen/mainpage.html > ${outdir}/html_${mode}/index.html
+  cd ${outdir}/html_${mode}
+  sed -e 's=\(::[[:alnum:]_]*\)&lt; .* &gt;=\1=' annotated.html > annstrip.html
+  mv annstrip.html annotated.html
+  cp ${srcdir}/docs/doxygen/tables.html tables.html
+  echo ::
+  echo :: HTML pages begin with
+  echo :: ${outdir}/html_${mode}/index.html
 }
 
 # Mess with the man pages.  We don't need documentation of the internal
Index: docs/html/documentation.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/documentation.html,v
retrieving revision 1.15
diff -u -3 -p -r1.15 documentation.html
--- docs/html/documentation.html	6 May 2002 11:43:56 -0000	1.15
+++ docs/html/documentation.html	17 Jul 2002 22:01:15 -0000
@@ -7,13 +7,14 @@
 <body>
 
 
-<p><B>All of these documents</B> (in fact, this entire homepage set) are
-   bundled with the library source, under the <code>docs</code> subdirectory,
-   for releases and snapshots.  The sole exception is the
+<p><strong>All of these documents</strong> (in fact, this entire homepage set)
+   are bundled with the library source, under the <code>docs</code>
+   subdirectory, for releases and snapshots.  The sole exception is the
    automatically-generated source documentation, available separately.
 </p>
 
-<hr>
+<hr />
+
 <h2><a name="4">Source Documentation</a></h2>
 <p>In addition to the distribution documentation (these pages), we also
    have a set of HTML documents generated from the sources themselves,
@@ -33,7 +34,7 @@
    <li><a href="libstdc++-html-USERS-3.0.96/index.html">docs for the most
        recent libstdc++ snapshot (3.0.96)</a>
    <li><a href="latest-doxygen/index.html">&quot;the latest collection&quot;</a>
-       (usually the snapshot collection or later; see the date on the first page)
+       (for the snapshot or later; see the date on the first page)
    </ul>
    Other collections (man pages, maintainer docs) are only available on the
    FTP sites.
@@ -43,19 +44,20 @@
    the same place as the HTML collections.  Start with <code>Intro(3)</code>.
 </p>
 
-<hr>
+<hr />
+
 <h2><a name="2">Configuring, Building, Installing</a></h2>
   <ul>
    <li><a href="configopts.html">Configure options</a>
-   <li><a href="install.html">Getting started: configure, build, install</a><br>
+   <li><a href="install.html">Getting started:  configure, build, install</a>
+   <!-- initial guess:  <li><a href="abi.txt">ABI documentation</a> -->
   </ul>
 
-<hr>
+<hr />
+
 <h2><a name="1">Introductory notes for libstdc++</a></h2>
    <p>This is a short list of text files pertaining to this implementation of
-      ISO 14882. A brief description follows the name of the file.
-   </p>
-   <p>
+      ISO 14882.  A brief description follows the name of the file.
       <ul>
          <li><a href="17_intro/BADNAMES">BADNAMES</a>
          - names to avoid because of potential collisions
@@ -84,7 +86,8 @@
       </ul>
    </p>
 
-<hr>
+<hr />
+
 <h2><a name="3">Chapter-Specific Information, Extensions, Notes and Advice</a></h2>
       <ol>
          <li><a href="17_intro/howto.html">Chapter 17 (Intro)</a>


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]