Commit Graph

29 Commits

Author SHA1 Message Date
Andrew Heather
510d9fc5a5 DOC: doxygen - activate treeview 2024-06-24 09:58:35 +01:00
Andrew Heather
281f136f38 DOC: Fixed some doxygen complaints 2021-12-20 14:17:59 +00:00
Mark Olesen
b61d4ab488 STYLE: adjust deprecations for OSspecific
- skip processing OSspecific/MSwindows since this can cause duplicate
  doxygen entries

STYLE: adjust formatting in code templates

STYLE: use std::string methods without extra qualifications
2019-12-13 11:08:12 +01:00
Mark Olesen
ffc1c5aca0 CONFIG: add additional modules/ directory and Module namespace
- 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.
2017-12-13 17:36:35 +01:00
Andrew Heather
c782b09322 ENH: Corrections to doxygen help 2017-08-10 11:14:10 +01:00
Andrew Heather
b9940cbbb1 COMP: Multiple changes - first clean build after latest merge - UNTESTED 2016-09-23 15:36:53 +01:00
Andrew Heather
9fbd612672 GIT: Initial state after latest Foundation merge 2016-09-20 14:49:08 +01:00
Henry Weller
d8fcf89570 Doxygen: Cleanup 'dot' files 2016-06-23 16:05:19 +01:00
Henry Weller
3990302a54 Updated and simplified the Doxygen documentation 2016-06-20 21:20:28 +01:00
Andrew Heather
d31adaeb5e ENH: (further) Doxygen documentation updates for module support 2016-06-17 17:41:04 +01:00
Andrew Heather
89ac7ff40b ENH: Doxygen updates 2016-01-08 12:37:24 +00:00
Henry Weller
a5be20fd37 Doxyfile: Upgraded for Doxygen-1.8.10 2015-10-30 21:38:06 +00:00
Henry
ee4e19ef85 Renamed folder -> directory for consistency with POSIX and the rest of OpenFOAM 2014-01-30 13:01:04 +00:00
andy
63cc7b534a ENH: Doxygen updates 2013-02-18 17:15:23 +00:00
andy
78c03fb65b ENH: Added .dox extension to doxygen file patterns 2012-07-19 16:07:50 +01:00
Henry
6bb467d902 Updated Doxygen setup from Chris 2011-06-14 22:13:37 +01:00
Henry
b6d4582300 Updated doc/Doxygen 2011-06-13 22:31:43 +01:00
Henry
b3cde56f27 Doxygen docs: Corrected doxyFilter to preserve line numbers
Also corrected many formatting errors in the comments in C and H files
2011-02-07 22:50:49 +00:00
Mark Olesen
0f57f4ec8a STYLE: move bin/doxyFilt -> bin/tools/doxyFilter
- normally only for doxygen generation, not needed in the path
2010-08-11 11:03:43 +02:00
Mark Olesen
9b92e3c451 use absolute path for header/footer in Doxyfile
- makes it easier to copy Doxyfile for local Doxygen generation
  ie, for debugging and writing without processing everything
2009-11-29 12:08:27 +01:00
henry
6912299aaf Corrected layout and indentation. 2008-12-02 12:01:46 +00:00
sergio
7c326218a8 Local Macros for Doxygen 2008-12-01 10:32:53 +00:00
sergio
2325ec4877 Doxyfile setup correction 2008-11-27 15:08:15 +00:00
sergio
747db59c3a basic.H
XiModel.H
SCOPELaminarFlameSpeed.H
basicXiSubXiEq.H
basicXiSubG.H
Doxyfile (include PATH to OpenCFD Macros)
doxyFilt (include class documentation in /src)
2008-11-27 11:22:08 +00:00
Mark Olesen
e346d0a20a restrict MAX_DOT_GRAPH_DEPTH = 3 for smaller (more readable) collaboration diagrams 2008-07-02 11:25:28 +02:00
Mark Olesen
b92e037e52 Doxygen filter changes * allow doxygen to process applications/**.H * use @cond/@endcond to suppress documenting classes/variables in applications/
- allows some access from applications to libraries
 - connection between application and local includes is still a bit weak,
   but is possible via the dirs.html navigation.
2008-06-13 13:16:02 +02:00
Mark Olesen
b2fd02df8d Doxygen : fixed rogue classes, simplified INPUT 2008-06-06 10:17:32 +02:00
andy
168c7e1ca9 removing FoamX 2008-06-04 13:40:02 +01:00
OpenFOAM-admin
3170c7c0c9 Creation of OpenFOAM-dev repository 15/04/2008 2008-04-15 18:56:58 +01:00