Mark Olesen
a54aff9d26
COMP: add wmake rules for mingw ( #1238 )
2019-04-28 13:36:50 +02:00
OpenFOAM bot
154029ddd0
BOT: Cleaned up header files
2019-02-06 12:28:23 +00:00
Mark Olesen
9e094f1f07
ENH: relocate WM_PROJECT_SITE default (issue #1050 )
...
- was PREFIX/site, now PROJECT/site
This avoids several issues when installing OpenFOAM in clusters
without an intermediate OpenFOAM-specific installation prefix.
The 'site' directory may have a reserved meaning in these situations
and it is undesirable to 'leak' upwards into the parent directory to
look for configuration files.
Placing the default within the project directory avoids this.
Alternative locations can be given via the WM_PROJECT_SITE variable.
2018-11-29 18:04:44 +01:00
Mark Olesen
85ffe4c648
ENH: improve consistency in version handling for foamEtcFile (issue #1010 )
...
- Prefer the $WM_PROJECT_VERSION from the environment, since this
is consistent with the foamEtcFile script, and matches better to
user expectations.
2018-11-22 12:00:50 +01:00
Mark Olesen
2aaae74ee1
STYLE: consistent ordering of "inline explicit" vs. "explicit inline"
...
- resolve in favour of "inline explicit", which had marginally more
uses and provides consistent prefixing for inline methods.
2018-05-30 12:11:13 +02: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
bc8420e14f
STYLE: trailing whitespace, doxygen, error messages from fileOperation
2017-12-13 17:56:34 +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
8728e8353f
STYLE: avoid explicit use of 'word' as HashTable template parameter
...
- less clutter and typing to use the default template parameter when
the key is 'word' anyhow.
- use EdgeMap instead of the longhand HashTable version where
appropriate
2017-05-10 13:44:27 +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
3dbd39146c
STYLE: consistency updates
2016-09-27 15:17:55 +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
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
0ea2023ae0
codingStyleGuide: Improved formatting
...
Resolves bug-report http://bugs.openfoam.org/view.php?id=2194
2016-08-20 09:33:11 +01:00
Henry Weller
caa354aa95
codingStyleGuide: Corrected typos
...
Patch contributed by Bruno Santos
Resolves bug-report http://bugs.openfoam.org/view.php?id=2193
2016-08-16 08:36:36 +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
Henry Weller
71fdcab771
Updated header documentation processed by Doxygen
2016-06-19 21:23:54 +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
Henry Weller
67de20df25
Further standardization of loop index naming: pointI -> pointi, patchI -> patchi
2016-05-18 21:20:42 +01:00
andy
fd9d801e2d
GIT: Initial commit after latest foundation merge
2016-04-25 11:40:48 +01:00
Henry Weller
3639f36d37
codingStyleGuide: Corrected sectioning
2016-04-20 10:33:19 +01:00
Henry Weller
a1f209c482
doc/codingStyleGuide.org: Added specification references in class headers
2016-04-19 10:02:14 +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
Henry Weller
56fa7c0906
Update code to use the simpler C++11 template syntax removing spaces between closing ">"s
2016-01-10 22:41:16 +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
c4d5f65a10
Completed update ...ErrorIn -> ...ErrorInFunction
...
Avoids the clutter and maintenance effort associated with providing the
function signature string.
2015-11-11 09:03:39 +00:00
Henry Weller
a5be20fd37
Doxyfile: Upgraded for Doxygen-1.8.10
2015-10-30 21:38:06 +00:00
Henry
99b99a46d4
codingStyleGuide: Minor updates
2015-02-25 10:55:51 +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
Henry
8c10661659
Remove tools used to update Doxygen documentation
2012-10-12 11:15:34 +01:00
andy
78c03fb65b
ENH: Added .dox extension to doxygen file patterns
2012-07-19 16:07:50 +01:00
andy
fa7053bd27
ENH: Added CSS for doxygen tables
2012-07-10 17:07:31 +01:00
Henry
852cdfb205
Removed unnecessary file
2011-08-24 17:18:05 +01:00
Henry
c2dd153a14
Copyright transfered to the OpenFOAM Foundation
2011-08-14 12:17:30 +01:00
Henry
f378580930
Update Doxygen css to relocate the search box
2011-06-15 11:45:12 +01:00
Henry
6c0f8e5935
Merge branch 'master' of /home/noisy3/OpenFOAM/OpenFOAM-2.0.0
2011-06-14 22:13:59 +01:00
Henry
6bb467d902
Updated Doxygen setup from Chris
2011-06-14 22:13:37 +01:00
andy
742fa75985
ENH: Updated web address
2011-06-14 12:53:43 +01:00
Henry
b6d4582300
Updated doc/Doxygen
2011-06-13 22:31:43 +01:00
Henry
6e40e2ed06
Moved doc/changes to OpenFOAM-nonRelease
2011-06-13 11:31:17 +01:00
mattijs
5ee41c79c3
STYLE: TODO: extraneous
2011-06-09 12:14:09 +01:00
Mark Olesen
e1137fe8e2
ENH: add convenience handling of "roots" when the slave roots are identical
...
- a single root entry is interpreted as being the same for all slaves
2011-04-15 13:32:59 +02:00
mattijs
5838649e19
ENH: Releasenotes-dev: updated functions
2011-03-25 10:53:56 +00:00
mattijs
20b1d49a82
ENH: dynamicCode: display line numbers
2011-03-25 04:43:29 +00:00
mattijs
b60866d98c
ENH: coded functionObject: added mesh()
2011-03-23 09:34:51 +00:00
mattijs
889b0a0488
ENH: Release-notes-dev: updated for coded functionObject
2011-03-23 04:58:00 +00:00
mattijs
cf99e5c800
ENH: codeStream: added codeLibs
2011-03-21 17:54:20 +00:00
mattijs
24280e3b4b
ENH: ReleaseNotes-dev: updated for codedFixedValue
2011-03-18 14:43:26 +00:00
mattijs
8a8ca63366
ENH: dynamicCode.org: updated to current status
2011-03-07 12:53:08 +00:00
Mark Olesen
97cd3af1ff
ENH: cleanup codeStream - use dynamicCode, dynamicCodeContext encapsulation
...
Problems remain with codedFixedValueFvPatchScalarField:
- readIfModified() notices change on system/codeDict, but the
codeProperties::setUnmodified() means that only a single entry will
get processed
- it appears that while dlclose() may (or may not) be actually closing
the library, there are probably still references about. This means
that a subsequent reloading still points to the original functions
and the lookup is not updated correctly.
2011-03-01 14:19:24 +01:00
Mark Olesen
51399bbbd1
STYLE: use dynamicCode/ instead of codeStream/ for dynamically generated code
2011-02-24 13:21:39 +01:00
Mark Olesen
b0e39f71c3
STYLE: minor cleanup on doc/code for codeStream
2011-02-23 16:17:25 +01:00
Mark Olesen
abde400dd5
Merge remote branch 'OpenCFD/master' into olesenm
...
Conflicts:
bin/foamCleanPath
2011-02-22 19:24:31 +01:00
mattijs
79939b9e18
ENH: #codeStream: preserve across preprocessing
...
- new token: token::VERBATIMSTRING
- writing of this type in primitiveEntry
- disabling of all functionEntries in entry
2011-02-22 15:29:57 +00:00
Mark Olesen
f0f2bfa632
ENH: refactor codeStreamTools, use for codedFixedValueFvPatchScalarField
2011-02-22 15:01:20 +01:00
mattijs
5f883935f3
ENH: codeStream.org: updated with system/codeDict
2011-02-22 12:15:10 +00:00
Henry
a55fa99f6e
Documentation: Updated ReleaseNotes and org-ified the codeStream description
2011-02-21 15:13:13 +00:00
mattijs
d6874f0fce
ENH: codeStream, codedFixedValue: renamed. added template directory.
2011-02-21 14:33:14 +00:00
mattijs
6d61e43f4a
ENH: onTheFly.txt: updated
2011-02-21 11:41:24 +00:00
mattijs
cfa58e0819
ENH: codeStream: documentation
2011-02-21 11:25:13 +00:00
Henry
a3d18c648b
codingStyleGuide: Added more details about Doxygen documentation
2011-02-09 12:37:33 +00:00
Henry
4275e01b66
Removed codingStyleGuide.pdf
2011-02-08 18:30:48 +00:00
Henry
8ca3ebc569
Documentation: Updated style guide
2011-02-08 18:28:13 +00:00
Henry
51e2e6160d
Documentation: Updated style guide
2011-02-08 18:25:44 +00:00
Henry
47c897577d
Documentation: Updated style guide
2011-02-08 18:25:16 +00:00
Henry
c3cb632c24
Documentation: converted javadoc @ to LaTeX style \ in Doxygen code docs
2011-02-08 18:22:00 +00:00
Henry
5339d687a4
doxygen/Doxyfile: Reformatted
2011-02-08 12:36:49 +00: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
mattijs
83a2a83160
ENH: staticLinkage.txt : how to link static
2011-02-02 11:25:06 +00:00
Mark Olesen
d93f3195e6
STYLE: use 1-col alphabetical output in reworked doxygen output
...
- avoids overflows in a fixed width boxes
2011-01-27 16:41:53 +01:00
mattijs
6bb8d56a09
ENH: pointAndEdgeSync : explanation about point sync
2011-01-20 14:24:07 +00:00