mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
ffc1c5aca0
- any code placed here should provide Allwmake and Allwclean scripts and normally have compilation targets into FOAM_APPBIN, FOAM_LIBBIN Since there is no standardize places for sources or applications, a simultaneous build of a module's doxygen documentation requires a minor bit of manual effort. Add (via symlink) the sources into the modules/doc/ directory to have them included in the normal OpenFOAM doxygen documentation generation. A makelink.example file is provided there as an example.
16 lines
607 B
Markdown
16 lines
607 B
Markdown
OpenFOAM Modules
|
|
================
|
|
|
|
This directory is a location to place additional OpenFOAM components
|
|
or tools and have them built as part of the normal OpenFOAM build
|
|
process. It is assumed that each subdirectory contain an appropriate
|
|
Allwmake file, and that they should in all likelihood also build into
|
|
`$FOAM_APPBIN` and `$FOAM_LIBBIN` instead of
|
|
`$FOAM_USER_APPBIN` and `$FOAM_USER_LIBBIN`.
|
|
|
|
These additional components may be added as git submodules, by script
|
|
or by hand.
|
|
|
|
To build the doxygen information for the components, it is also
|
|
necessary to link the directories to the doc/ subdirectory.
|