| commit | a510b5bfb200287c92ed9bbdbb0703b55e1e34d7 | |
| author | Michael Wild <themiwi@users.sourceforge.net> | |
| Fri, 12 Jun 2009 08:33:15 +0000 (12 10:33 +0200) | ||
| committer | Michael Wild <themiwi@users.sourceforge.net> | |
| Mon, 29 Jun 2009 11:58:42 +0000 (29 13:58 +0200) | ||
| tree | d237219f4a3bcfb9ea73f5bc0ab0f82cb6afca41 | treesnapshot (tar.gz zip) |
| parent | cd62a0e1b2eba411fe21c12ac6b7bbf9d2d03c63 | commitdiff |
ENH: Added man-page creation script and CMake function
The script data/utilities/doxyToAsciidoc extracts the man-page content
from the documentation comments in the head of the application source
files using the AWK script data/shellFunctions/doxyToAsciidoc.awk. The
function ff_create_man_page_from_doxy firstly uses this script to
extract the docs into ${CMAKE_SOURCE_DIR}/doc/man/manTemplates which
then are configured using configure_file. These templates are then
distributed with FreeFOAM. The idea behind this is that most users don't
want to set up a working Asciidoc toolchain.
The special target "update_man_templates" updates the man-page
templates. The CMake build system also screams and shouts if a man-page
template doesn't exist and asks the user to build "update_man_templates"
and then re-configure again.
Signed-off-by: Michael Wild <themiwi@users.sourceforge.net>
The script data/utilities/doxyToAsciidoc extracts the man-page content
from the documentation comments in the head of the application source
files using the AWK script data/shellFunctions/doxyToAsciidoc.awk. The
function ff_create_man_page_from_doxy firstly uses this script to
extract the docs into ${CMAKE_SOURCE_DIR}/doc/man/manTemplates which
then are configured using configure_file. These templates are then
distributed with FreeFOAM. The idea behind this is that most users don't
want to set up a working Asciidoc toolchain.
The special target "update_man_templates" updates the man-page
templates. The CMake build system also screams and shouts if a man-page
template doesn't exist and asks the user to build "update_man_templates"
and then re-configure again.
Signed-off-by: Michael Wild <themiwi@users.sourceforge.net>
213 files changed: