Menu
▾
▴
[Plplot-cvs] SF.net SVN: plplot:[12489] trunk/www/documentation.php.in
|
From: <ai...@us...> - 2013-08-19 21:55:37
|
Revision: 12489
http://sourceforge.net/p/plplot/code/12489
Author: airwin
Date: 2013-08-19 21:55:31 +0000 (Mon, 19 Aug 2013)
Log Message:
-----------
Reorder so that doxygen-generated documentation is last in the list on
our website.
Modified Paths:
--------------
trunk/www/documentation.php.in
Modified: trunk/www/documentation.php.in
===================================================================
--- trunk/www/documentation.php.in 2013-08-19 20:42:06 UTC (rev 12488)
+++ trunk/www/documentation.php.in 2013-08-19 21:55:31 UTC (rev 12489)
@@ -14,7 +14,6 @@
<div id="leftside">
<h3>PLplot Documentation</h3>
<ul class="arrowlist">
- <li> <a href="doxygen/html">Browse doxygen-generated documentation</a> </li>
<li> <a href="docbook-manual/@BASE_HTML@">Browse the latest on-line documentation</a> </li>
<li> <a href="docbook-manual/@BASE@.ps.gz">PostScript form of documentation (<?php $size = number_format((filesize("docbook-manual/@BASE@.ps.gz")/1024/1024),2); echo $size;?> MB)</a> </li>
<li> <a href="docbook-manual/@BASE@.pdf">PDF form of documentation (<?php $size = number_format((filesize("docbook-manual/@BASE@.pdf")/1024/1024),2); echo $size;?> MB)</a> </li>
@@ -22,35 +21,36 @@
<li> <a href="docbook-manual/@BASE_INFO@.tar.gz">Info documentation tarball (<?php $size = number_format((filesize("docbook-manual/@BASE_INFO@.tar.gz")/1024/1024),2); echo $size;?> MB)</a> </li>
<li> <a href="docbook-manual/@BASE_MAN@.tar.gz">Man pages tarball (API chapter in nroff format) (<?php $size = number_format((filesize("docbook-manual/@BASE_MAN@.tar.gz")/1024/1024),2); echo $size;?> MB)</a> </li>
<li> <a href="docbook-manual/@BASE_HTML@.tar.gz">HTML results tarball (<?php $size = number_format((filesize("docbook-manual/@BASE_HTML@.tar.gz")/1024/1024),2); echo $size;?> MB)</a> </li>
+ <li> <a href="doxygen/html">Browse doxygen-generated documentation</a> </li>
</ul>
<p>
-The first documentation results above have been generated by doxygen
-directly from a special form of comments in our source code. The
-remaining documentation results above have been generated from our
-DocBook/XML source files in doc/docbook/src using a variety of DocBook
-backend tools. The doxygen and DocBook documentation builds happen
+All but the doxygen-generated results above have been generated from
+our DocBook/XML source files in doc/docbook/src using a variety of
+DocBook backend tools. The doxygen results above have been generated
+by doxygen directly from a special form of comments in our source
+code. The DocBook and doxygen documentation builds happen
automatically (only on Linux since the required tools are only
-available for that O/S) with our CMake-based build system if you
-specify the cmake options "-DBUILD_DOX_DOC=ON -DBUILD_DOC=ON". For
+available for that platform) with our CMake-based build system if you
+specify the cmake options "-DBUILD_DOC=ON -DBUILD_DOX_DOC=ON". For
more details about building the DocBook form of our documentation and
testing it, please look at the file doc/docbook/README.developers in
the source tree.
</p>
<p>
For those wishing to make some contribution to PLplot, helping out
-with either/both the doxygen or DocBook documentation is a good place
-to start. For the doxygen case, the documentation is controlled by a
-special form of comments in our source files. See src/plllegend.c for
-a good example of how to document arguments of PLplot functions. Note
-there are many other files in src without this argument documentation
-at the present time so there is plenty of scope to help out here. For
-the DocBook case, the DocBook/XML syntax is quite straightforward to
-understand if you simply follow the form of what is already done in
-the files in the doc/docbook/src subdirectory of the source
-tree. However, if you want to dig a little deeper into DocBook, then
-this on-line book, <a
+with either/both the DocBook or doxygen documentation is a good place
+to start. For the DocBook case, the DocBook/XML syntax is quite
+straightforward to understand if you simply follow the form of what is
+already done in the files in the doc/docbook/src subdirectory of the
+source tree. However, if you want to dig a little deeper into DocBook,
+then this on-line book, <a
href="http://www.docbook.org/tdg/en/html/docbook.html">"DocBook: The
-Definitive Guide"</a>, is an excellent reference.
+Definitive Guide"</a>, is an excellent reference. For the doxygen
+case, the documentation is controlled by a special form of comments in
+our source files. See src/plllegend.c for a good example of how to
+document arguments of PLplot functions. Note there are many other
+files in src without this argument documentation at the present time
+so there is plenty of scope to help out here.
</p>
</div>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|