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
0c5ff2efe8
Merge remote-tracking branch 'origin/master' into develop
2019-12-11 00:13:46 +01:00
Mark Olesen
3e76ef7b5b
DOC: update repository links
2019-12-09 14:54:25 +01:00
Mark Olesen
98467036b3
STYLE: regularize quoting and exit on failed 'cd'
2019-11-13 13:19:16 +01:00
OpenFOAM bot
e9219558d7
GIT: Header file updates
2019-10-31 14:48:44 +00:00
Mark Olesen
e6dfb39c66
STYLE: remove unnecessary stdout, stderr /dev/null redirects
...
- no stderr redirect needed:
* 'command -v'
- no stdout/stderr redirect needed:
* 'rm -f'
STYLE: consistent spacing after redirects
2019-11-06 10:44:36 +01:00
OpenFOAM bot
154029ddd0
BOT: Cleaned up header files
2019-02-06 12:28:23 +00:00
Mark Olesen
ab38c04006
STYLE: note deprecated status for NamedEnum
2018-01-09 16:06:40 +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
Mark Olesen
5947f9a337
ENH: more succinct output from command-line errors.
...
- unknown options or missing option values now emit a shorter message
without the entire usage. This makes it easier to identify the errors
and is better aligned with the behaviour of GNU system tools.
====
$ simpleFoam -case
Using: OpenFOAM-plus (see www.OpenFOAM.com)
Build: plus-01234
Error: option '-case' requires an argument
See 'simpleFoam -help' for usage
====
- provide for reduced (-help) and full (-help-full) usage information.
In many cases the reduced usage provided sufficient and easier
to find the information.
- make -srcDoc an alias for -doc-source
- no warnings about option aliases for future dates.
2017-11-24 10:27:11 +01:00
Mark Olesen
0cc4ab73b7
ENH: adjust doxygen wrapper to accept multiple input directories
...
- the -dir option was added in commit c1c6243c3e
to allow quick
testing of documentation for a set of classes.
This was largely replicated in commit 843d83117, but accepting
multiple directories.
Apply some of the same ideas here and avoid creation of a tmp file.
2017-09-29 18:36:48 +02:00
Andrew Heather
c782b09322
ENH: Corrections to doxygen help
2017-08-10 11:14:10 +01:00
Andrew Heather
0881052ce1
ENH: doxygen - re-added css for OpenFOAM tables
2017-06-26 13:27:58 +01:00
Mark Olesen
c1c6243c3e
ENH: pass through doc/Allwmake arguments, add -config, -dir options
...
- can run doxygen with an alternative Doxyfile, which is useful
when verifying generated content for particular classes.
Eg,
PATH/doc/Allwmake -dir $PWD
2017-05-16 10:53:07 +02:00
Mark Olesen
7b09bab34f
DOC: adjust doxygen tag for 4-digit release tags
2017-02-06 09:15:18 +01:00
Mark Olesen
3e5307111c
STYLE: unify cd, check for the cwd and error message
2017-02-06 09:13:59 +01:00
Andrew Heather
28e37bbec9
STYLE: Consistency updates
2016-12-16 14:36:48 +00:00
Andrew Heather
c0f44ac4f3
MRG: Integrated foundation code
2016-12-12 12:10:29 +00:00
Henry Weller
80db302666
Allwmake: Remove 'set -x' which generates a lot of noise
...
'set -x' should be used for debugging.
Added command printing into wmake and Allwmake as a replacement for
'set -x' to log current target.
2016-11-13 18:08:22 +00: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
Andrew Heather
16e4b25ac0
BUG: Corrected Doxygen style sheet - patch contributed by Bruno Santos. Fixes #217
2016-08-25 13:36:43 +01:00
Henry Weller
56985cdae8
Doxygen: Updated header
2016-06-23 16:06:12 +01:00
Henry Weller
d8fcf89570
Doxygen: Cleanup 'dot' files
2016-06-23 16:05:19 +01:00
Henry Weller
04e56bfa6d
doc/Doxygen/customdoxygen.css: simplified
2016-06-21 11:04:50 +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
1fd05b2d1b
Merge branch 'develop' of develop.openfoam.com:Development/OpenFOAM-plus into develop
2016-06-10 15:40:45 +01:00
andy
fd9d801e2d
GIT: Initial commit after latest foundation merge
2016-04-25 11:40:48 +01:00
Henry Weller
a8b6ebdb52
doc/Doxygen/_Footer: Updated link to http://openfoam.org
...
Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=2053
2016-04-16 09:57:25 +01:00
Henry Weller
889580541b
doc/Doxygen/_Footer: Updated copyright date
...
Patch contributed by Bruno Santos
2016-04-16 09:54:21 +01:00
Henry Weller
1a5ba9c4ff
scotchDecomp, ptscotchDecomp: Updated documentation
...
Patch contributed by Bruno Santos
Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=2032
2016-03-25 22:36:13 +00:00
Henry Weller
e57874859a
Updated Doxygen documentation and files
...
Contributed by Bruno Santos
Resolves patch report http://www.openfoam.org/mantisbt/view.php?id=2023
Update online documentation http://openfoam.github.io/Documentation-dev/html/
2016-03-14 11:00:24 +00:00
Henry Weller
350d03246e
scripts: Reformat with consistent section separators
2016-02-15 18:30:24 +00:00
Andrew Heather
f8ab380174
ENH: Doxygen - updated path to source files on develop.openfoam.com
2016-02-15 10:29:22 +00:00
Andrew Heather
89ac7ff40b
ENH: Doxygen updates
2016-01-08 12:37:24 +00:00
Andrew Heather
04752147c8
GIT: Resolved conflict on merge from upstream
2015-12-22 16:49:44 +00:00
Henry Weller
a5be20fd37
Doxyfile: Upgraded for Doxygen-1.8.10
2015-10-30 21:38:06 +00:00
Henry
62ab2a5d08
doc/Doxygen/Allwmake: Automated the setting of FOAM_ONLINE_REPO
...
Patch provided by Bruno Santos
Resolves bug-report http://www.openfoam.org/mantisbt/view.php?id=1528
2015-02-14 16:04:01 +00:00
Henry
156fd4dcc6
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
Henry
844b283030
New version of wmake supporting out-of-tree object and dependency files
2014-12-14 21:42:18 +00:00
Henry
49de6a3a4e
Updated documentation
2014-12-10 12:39:58 +00:00
Henry
ee4e19ef85
Renamed folder -> directory for consistency with POSIX and the rest of OpenFOAM
2014-01-30 13:01:04 +00:00
mattijs
b53fff01d7
Merge branch 'master' of /home/dm4/OpenFOAM/repositories/OpenFOAM-dev
...
Conflicts:
doc/Doxygen/css/doxygen.css
2013-12-02 11:30:36 +00:00
andy
6544abe389
ENH: Updated doygen css (Chris)
2013-11-21 14:57:44 +00:00
mattijs
ec5e2e7b88
ENH: Doxygen: corrected css for indenting
2013-11-21 14:16:24 +00:00
andy
217243109d
ENH: Updates to documentation (Chris)
2013-02-22 10:55:17 +00:00
andy
63cc7b534a
ENH: Doxygen updates
2013-02-18 17:15:23 +00:00