[Plplot-cvs] SF.net SVN: plplot:[11705] trunk/www/documentation.php.in

[<ai...@us...>]

Revision: 11705
          http://plplot.svn.sourceforge.net/plplot/?rev=11705&view=rev
Author:   airwin
Date:     2011-04-14 20:21:47 +0000 (Thu, 14 Apr 2011)

Log Message:
-----------
Improve integration of doxygen-generated results into the Documentation
page of our website.

Modified Paths:
--------------
    trunk/www/documentation.php.in

Modified: trunk/www/documentation.php.in
===================================================================
--- trunk/www/documentation.php.in	2011-04-14 19:42:07 UTC (rev 11704)
+++ trunk/www/documentation.php.in	2011-04-14 20:21:47 UTC (rev 11705)
@@ -14,8 +14,8 @@
 		<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="doxygen/html">Browse doxygen-generated 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>
 	      <li> <a href="docbook-manual/@BASE@.dvi">DVI form of documentation (<?php $size = number_format((filesize("docbook-manual/@BASE@.dvi")/1024/1024),2); echo $size;?> MB)</a> </li>
@@ -24,10 +24,33 @@
 	      <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>
 			</ul>
 <p>
-The documentation results above have been generated from our DocBook/XML source files in doc/docbook/src using a variety of DocBook backend tools.  The documentation build happens 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 option -DBUILD_DOC=ON.  For more details about building this documentation and testing it, please look at the file doc/docbook/README.developers in the source tree.
+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
+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
+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 the documentation is a good place to start.  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.
+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
+href="http://www.docbook.org/tdg/en/html/docbook.html">"DocBook: The
+Definitive Guide"</a>, is an excellent reference.
 </p>
 		</div>
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.