Commit Graph

12 Commits

Author SHA1 Message Date
137a40ef56 Documentation: Moved "Notes" entries into the corresponding "Description" or "Usage"
This simplifies parsing the headers and ensures the notes are included in the
text they relate to by both Doxygen and foamInfo.
2022-05-12 09:51:14 +01:00
f29114bfb6 Removed incomplete, inconsistent, confusing and un-maintained header clutter 2018-06-20 15:55:18 +01:00
cf89a3094a Updated and simplified the Doxygen documentation 2016-06-20 21:20:28 +01:00
988b5680ac bin/tools/doxyFilter.sed: Corrected 2016-06-17 18:59:09 +01:00
8a5304edf6 Doxygen documentation: Standardized the 'See also' heading 2016-06-17 17:31:34 +01:00
2ca0a6f362 Doxygen documentation: Use the standard 'Usage' rather than the '\heading....' 2016-06-17 17:22:24 +01:00
4ebaed67f9 Doxygen documentation: Remove superfluous linebreak 2016-06-17 17:13:39 +01:00
97668c21a3 functionObjects: Moved functionObjects namespace documentation into functionObject.H 2016-05-04 13:56:36 +01:00
fa0656c358 scripts: Reformat with consistent section separators 2016-02-15 18:30:24 +00:00
ae4cdef8b5 Doxygen: Updated scripts and css files to process OpenFOAM header files more robustly
and generate cleaner HTML files.
Thanks to Bruno Santos for various fixes and improvements.
Resolves bug reports:
    http://www.openfoam.org/mantisbt/view.php?id=1516
    http://www.openfoam.org/mantisbt/view.php?id=1016
    http://www.openfoam.org/mantisbt/view.php?id=1512
2015-02-09 18:06:35 +00:00
cb23867daa bin/tools/doxyFilter.sed: Add support for 2-line Class name:
Class
     Foam::className
 =>
 \\class Foam::className

 Class
     Foam::namespaceName::
         className
 =>
 \\class Foam::namespaceName::className

Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=252
2015-01-29 08:16:59 +00:00
446e5777f0 Add the OpenFOAM source tree 2014-12-10 22:40:10 +00:00