songtianlun/openfoam
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
21,855 Commits 104 Branches 33 Tags 325 MiB
8dc295bf01
Commit Graph

161 Commits

Author SHA1 Message Date
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