[certi-cvs] certi/doc certi_install_doc.tree certi_install....

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      08/10/10 12:37:07

Modified files:
        doc            : certi_install_doc.tree certi_install.cnf.in 
                         certi_install.dox CMakeLists.txt 
Added files:
        doc            : certi_install_header.html 
                         certi_introduction.dox 

Log message:
        Doxygen documentation update

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install_doc.tree?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install.cnf.in?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install.dox?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/CMakeLists.txt?cvsroot=certi&r1=1.5&r2=1.6
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install_header.html?cvsroot=certi&rev=3.1
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_introduction.dox?cvsroot=certi&rev=3.1

Patches:
Index: certi_install_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_install_doc.tree,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- certi_install_doc.tree      9 Oct 2008 23:39:58 -0000       3.1
+++ certi_install_doc.tree      10 Oct 2008 12:37:06 -0000      3.2
@@ -23,27 +23,17 @@
 */
  
 /**
- * @mainpage
- * \section intro_sec Introduction
+ * \page index
  *
+ * <h1> CERTI Installation Documentation </h1>
+ * \n
  * This is the CERTI installation documentation.
- * CERTI is an Open Source HLA compliant  
- * <a href="http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation)">
- * RunTime Infrastructure (RTI)</a>.
- * You'll find hereafter the documentation for building and installing CERTI.
- * CERTI is primarily developed and maintained by the Toulouse research center 
of ONERA [http://www.onera.fr], the French Aerospace Labs. 
- * The primary goal of CERTI is to be used in research activities but CERTI 
has a growing
- * number of users and contributors among the CERTI Open Source community.
+ * The installation documentation is divided into several part:
  * 
- * People interested in CERTI may join the CERTI Open Source
- * community at <a href="https://savannah.nongnu.org/projects/certi";>
- * https://savannah.nongnu.org/projects/certi </a> and/or
- * by using the mailing list 
- * <a href="http://lists.nongnu.org/mailman/listinfo/certi-devel";>
- * http://lists.nongnu.org/mailman/listinfo/certi-devel </a>
- * for discussion regarding CERTI usage.
- *
- * \subpage Installation
+ * <ul>
+ *  <li>Section \ref intro</li>
+ *  <li>Section \ref install</li>
+ * </ul> 
  *
  */
  

Index: certi_install.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_install.cnf.in,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- certi_install.cnf.in        9 Oct 2008 23:39:56 -0000       3.1
+++ certi_install.cnf.in        10 Oct 2008 12:37:06 -0000      3.2
@@ -17,7 +17,7 @@
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
 # by quotes) that should identify the project.
 
-PROJECT_NAME           = CERTI_Install
+PROJECT_NAME           = "CERTI Installation"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
 # This could be handy for archiving the generated documentation or 
@@ -435,6 +435,7 @@
 # with spaces.
 
 INPUT                  = "${CMAKE_SOURCE_DIR}/doc/certi_install_doc.tree" \
+                         "${CMAKE_SOURCE_DIR}/doc/certi_introduction.dox" \
                          "${CMAKE_SOURCE_DIR}/doc/certi_install.dox"
 
 # If the value of the INPUT tag contains directories, you can use the 
@@ -610,7 +611,7 @@
 # each generated HTML page. If it is left blank doxygen will generate a 
 # standard header.
 
-HTML_HEADER            = certi_header.html
+HTML_HEADER            = certi_install_header.html
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
 # each generated HTML page. If it is left blank doxygen will generate a 
@@ -675,7 +676,7 @@
 # top of each HTML page. The value NO (the default) enables the index and 
 # the value YES disables it.
 
-DISABLE_INDEX          = NO
+DISABLE_INDEX          = YES
 
 # This tag can be used to set the number of enum values (range [1..20]) 
 # that doxygen will group on one line in the generated HTML documentation.

Index: certi_install.dox
===================================================================
RCS file: /sources/certi/certi/doc/certi_install.dox,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- certi_install.dox   9 Oct 2008 23:39:56 -0000       3.1
+++ certi_install.dox   10 Oct 2008 12:37:06 -0000      3.2
@@ -1,6 +1,7 @@
 /**
- * \page Installation Installing and using CERTI SDK
+ * \page install Installing CERTI SDK 
  * 
+ * \addindex installation
  * CERTI SDK comes as either as an installer (binary) or compressed tar source 
archives.
  * The primary distribution format is gzip compressed tar source archive 
(.tar.gz)
  * or ZIP archive (.zip) and may be found on Savannah CERTI download area: <a 
href="http://download.savannah.nongnu.org/releases/certi/";> 
http://download.savannah.nongnu.org/releases/certi/ </a>.

Index: CMakeLists.txt
===================================================================
RCS file: /sources/certi/certi/doc/CMakeLists.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- CMakeLists.txt      9 Oct 2008 23:39:55 -0000       1.5
+++ CMakeLists.txt      10 Oct 2008 12:37:07 -0000      1.6
@@ -23,13 +23,11 @@
 ENDIF(BUILD_DOC)
 
 IF (DOXYGEN_FOUND)
-  #pages global to all documentation  
-  SET(CERTI_STATIC_PAGES certi_header.html certi_footer.html)
   #install documentation
   IF (BUILD_DOC_INSTALL)  
       DoxyTools_ADD_DocSet(Install
                            CONFIG_FILE certi_install.cnf
-                           INPUT_FILES ${CERTI_STATIC_PAGES}
+                           INPUT_FILES certi_install_header.html 
certi_footer.html
                            DOC_TYPE    html
                            OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/install
                            COMMENTS "CERTI installation documentation"
@@ -40,7 +38,7 @@
   IF (BUILD_DOC_USER)  
       DoxyTools_ADD_DocSet(User
                            CONFIG_FILE certi_user.cnf
-                           INPUT_FILES ${CERTI_STATIC_PAGES}
+                           INPUT_FILES certi_header.html certi_footer.html
                            DOC_TYPE    html
                            OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/user
                            COMMENTS "CERTI user documentation"
@@ -51,7 +49,7 @@
   IF (BUILD_DOC_DEVELOPER)  
       DoxyTools_ADD_DocSet(Developer
                            CONFIG_FILE certi_developer.cnf
-                           INPUT_FILES ${CERTI_STATIC_PAGES}
+                           INPUT_FILES certi_header.html certi_footer.html
                            DOC_TYPE    html
                            OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/developer
                            COMMENTS "CERTI developer documentation"

Index: certi_install_header.html
===================================================================
RCS file: certi_install_header.html
diff -N certi_install_header.html
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ certi_install_header.html   10 Oct 2008 12:37:06 -0000      3.1
@@ -0,0 +1,5 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>$title</title>
+<link href="$relpath$certi.css" rel="stylesheet" type="text/css">
+</head><body>

Index: certi_introduction.dox
===================================================================
RCS file: certi_introduction.dox
diff -N certi_introduction.dox
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ certi_introduction.dox      10 Oct 2008 12:37:06 -0000      3.1
@@ -0,0 +1,21 @@
+/**
+ * \page intro Introduction
+ *
+ * \addindex Introduction
+ * CERTI is an Open Source HLA compliant  
+ * <a href="http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation)">
+ * RunTime Infrastructure (RTI)</a>.
+ * You'll find hereafter the documentation for building and installing CERTI.
+ * CERTI is primarily developed and maintained by the Toulouse research center 
of ONERA [http://www.onera.fr], the French Aerospace Labs. 
+ * The primary goal of CERTI is to be used in research activities but CERTI 
has a growing
+ * number of users and contributors among the CERTI Open Source community.
+ * 
+ * People interested in CERTI may join the CERTI Open Source
+ * community at <a href="https://savannah.nongnu.org/projects/certi";>
+ * https://savannah.nongnu.org/projects/certi </a> and/or
+ * by using the mailing list 
+ * <a href="http://lists.nongnu.org/mailman/listinfo/certi-devel";>
+ * http://lists.nongnu.org/mailman/listinfo/certi-devel </a>
+ * for discussion regarding CERTI usage.
+ *  
+ */