FLUID: Separates developer and user documentation

fluid/.gitignore

@@ -11,3 +11,4 @@ pixmaps/*.bck
 # local documentation generation
 
 documentation/html/
+documentation/html-dev/

fluid/CMakeLists.txt

@@ -97,7 +97,7 @@ source_group("Header Files" FILES ${HEADERFILES})
 
 # make a group in the IDE for easy access to documentation files
 
-set ( DOC_FILES
+set ( USER_DOC_FILES
   Doxyfile
   documentation/src/index.dox
   documentation/src/page_introduction.dox
@@ -116,13 +116,20 @@ set ( DOC_FILES
   documentation/src/page_legal.dox
   documentation/src/page_conclusion.dox
 )
-source_group("Documentation" FILES ${DOC_FILES})
+source_group("Documentation: User" FILES ${USER_DOC_FILES})
+
+set ( DEV_DOC_FILES
+  Doxyfile-dev
+  documentation/src-dev/index.dox
+  documentation/src-dev/page_introduction.dox
+)
+source_group("Documentation: Developer" FILES ${DEV_DOC_FILES})
 
 # Build a local object library to avoid compiling all source files
 # for all fluid targets (fluid, fluid-cmd, fluid-shared). This
 # library includes everything except the main program (fluid.cxx).
 
-add_library (fluid-lib OBJECT EXCLUDE_FROM_ALL ${CPPFILES} ${HEADERFILES} ${DOC_FILES})
+add_library (fluid-lib OBJECT EXCLUDE_FROM_ALL ${CPPFILES} ${HEADERFILES} ${USER_DOC_FILES} ${DEV_DOC_FILES})
 
 # Build fluid with all its variants (fluid-cmd, fluid-shared) ...
 

fluid/Doxyfile

@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = Fluid
+PROJECT_NAME           = Fluid User Manual
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = icons/fluid-48.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -863,7 +863,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = .
+INPUT                  = documentation/src
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -892,11 +892,7 @@ INPUT_ENCODING         = UTF-8
 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
 # *.vhdl, *.ucf, *.qsf and *.ice.
 
-FILE_PATTERNS          = *.H \
+FILE_PATTERNS          = *.dox
-                         *.h \
-                         *.c \
-                         *.cxx \
-                         *.dox
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.

fluid/documentation/src-dev/index.dox

@@ -0,0 +1,42 @@
+
+
+/**
+
+ \mainpage FLUID Developer Documentation
+
+ <TABLE CELLPADDING="8" CELLSPACING="0" SUMMARY="TITLE BAR" WIDTH="100%" BORDER="0">
+ <TR>
+ <TD><CENTER>
+ \image html fluid-128.png
+ \image latex fluid-128.png  "" width=3cm
+ 
+ <B>FLUID 1.4.0 Developer Documentation</B>
+
+ By F.&nbsp;Costantini, D.&nbsp;Gibson, M.&nbsp;Melcher,
+ A.&nbsp;Schlosser, B.&nbsp;Spitzak and M.&nbsp;Sweet.
+
+ Copyright © 1998 - 2023 by Bill Spitzak and others.
+ </CENTER></TD>
+ </TR>
+ </TABLE>
+ <TABLE CELLPADDING="8" CELLSPACING="0" SUMMARY="TITLE BAR" WIDTH="100%" BORDER="0">
+ <TR>
+ <TD style="text-align: center;">
+ This software and manual are provided under the terms of the GNU
+ Library General Public License. Permission is granted to reproduce
+ this manual or any portion for any purpose, provided this copyright
+ and permission notice are preserved.
+ </TD>
+ </TR>
+ </TABLE>
+ <TABLE CELLPADDING="8" CELLSPACING="0" SUMMARY="Table of Contents" WIDTH="100%" BORDER="0">
+ <TR>
+ <TD ALIGN="LEFT" VALIGN="TOP">
+
+ \subpage page_introduction
+
+ </TD>
+ </TR>
+ </TABLE>
+
+*/

fluid/documentation/src-dev/page_introduction.dox

@@ -0,0 +1,9 @@
+/**
+
+ \page page_introduction Introduction
+
+ \tableofcontents
+
+ - Provide an introduction that explains the purpose of the user manual and any prerequisites or system requirements.
+
+ */