089778b878
Guides: corrections to 4.9.2 Macro expansion
2022-11-26 18:13:21 +00:00
84552ed7cf
Updated for OpenFOAM-10
2022-07-11 12:20:13 +01:00
b5184a9e90
doc/Guides: Updated
2021-07-15 14:08:22 +01:00
ee777e4083
Standardise on British spelling: -ize -> -ise
...
OpenFOAM is predominantly written in Britain with British spelling conventions
so -ise is preferred to -ize.
2021-06-01 19:11:58 +01:00
55f751641e
Standardise on British spelling: initialize -> initialise
...
OpenFOAM is predominantly written in Britain with British spelling conventions
so -ise is preferred to -ize.
2021-06-01 14:51:48 +01:00
def4772281
Documentation: Centred the Class Declaration comment
...
Patch contributed by Institute of Fluid Dynamics,
Helmholtz-Zentrum Dresden - Rossendorf (HZDR)
2020-08-28 13:28:58 +01:00
9cbaefddff
Updated for OpenFOAM-8
2020-07-21 17:51:46 +01:00
4d73bfad2a
Doxygen::Doxyfile: Replaced the index bar with the more convenient tree-view
2020-05-22 18:42:59 +01:00
5ae7052e12
Corrected typos in User Guide
...
Based on PDF provided by Herbert Tauber
Resolves bug-report https://bugs.openfoam.org/view.php?id=3405
2019-12-07 13:26:01 +00:00
803fdc07f9
Updated User Guides to version 7
2019-07-05 14:21:52 +01:00
bcbfe542cf
Rationalised WM_PROJECT_SITE and WM_PROJECT_INST_DIR in foamEtcFile and etcFiles
...
for consistency with WM_PROJECT. Now "etc" files are assumed to be in etc
sub-directories of WM_PROJECT_SITE and WM_PROJECT_INST_DIR allowing other files
to be stored in those directories. The search order is now:
Search for files from user/group/shipped directories.
The search scheme allows for version-specific and
version-independent files using the following hierarchy:
- \b user settings:
- ~/.OpenFOAM/\<VERSION\>/
- ~/.OpenFOAM/
- \b group (site) settings (when $WM_PROJECT_SITE is set):
- $WM_PROJECT_SITE/\<VERSION\>/etc/
- $WM_PROJECT_SITE/etc/
- \b group (site) settings (when $WM_PROJECT_SITE is not set):
- $WM_PROJECT_INST_DIR/site/\<VERSION\>/etc/
- $WM_PROJECT_INST_DIR/site/etc/
- \b other (shipped) settings:
- $WM_PROJECT_DIR/etc/
\return The list of full paths of all the matching files or
an empty list if the name cannot be found.
Optionally abort if the file cannot be found.
Optionally stop search after the first file has been found.
This change was proposed and agreed by the sponsors of the OpenFOAM project on
the OpenFOAM Hub, see https://openfoam.org/maintenance/
2018-11-28 22:00:34 +00:00
dffe3213d7
doc/Doxygen/Doxyfile: Increased FORMULA_FONTSIZE to 16
2018-10-07 10:24:52 +01:00
529010cb5b
Doxyfile: Added amsmath to EXTRA_PACKAGES for complex equation formatting
2018-09-25 08:27:19 +01:00
26478060e0
Created .C files corresponding to the <application>.L files for Doxygen and -doc option
...
Resolves bug-report https://bugs.openfoam.org/view.php?id=3070
2018-09-07 15:07:19 +01:00
490a297190
Doxyfile: include .L files and exclude .C files which clash with application source files
...
Resolves bug-report https://bugs.openfoam.org/view.php?id=3070
2018-09-06 18:05:22 +01:00
0dfcae6a26
doc/Doxygen/Doxyfile: Exclude src/mesh/blockMesh/blockMesh/blockMesh.C
...
to avoid clash with the blockMesh.C application source file
2018-09-06 00:00:19 +01:00
71a4e548df
Updated git hooks to check new header format
2018-07-09 16:59:03 +01:00
d6f41c02e7
Updated Guides
2018-07-06 23:22:34 +01:00
bf54ab67e1
Updated OpenFOAM Foundation web-link in headers
2018-07-06 21:42:54 +01:00
45e61f38f7
Doxyfile: Increased LOOKUP_CACHE_SIZE to 3 as recommended by running doxygen
2018-06-20 20:06:40 +01:00
8743c2fa26
doxygen: Allwmake script POSIX compliance
2017-09-24 20:55:19 +01:00
91abe4ffd9
doxygen: updated -online option
...
Resolves bug report https://bugs.openfoam.org/view.php?id=2702
2017-09-21 14:01:50 +01:00
843d831172
doxygen: Added option to compile specific directories
...
The doc/Doxygen/Allwmake script can now be given directories as
arguments, which will be built instead of the usual src/ and
applications/ directories. This allows testing the documentation of a
limited set of files without building everything.
The outer doc/Allwmake script has also been deleted.
2017-09-20 16:19:24 +01:00
44eca0bb79
doc/Guides: Updated
2017-07-25 14:18:58 +01:00
7e04e6b55f
Reinstated operation of "-doc" and "-srcDoc"
...
Changed Doxyfile to generate descriptive names for the HTML files.
Added "-file" option to firefox to read the HTML file name from the command line.
2017-05-12 18:35:50 +01:00
48e3fb7805
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
4ebf07f9cc
doc/Guides: Updated to OpenFOAM-4.0
2016-08-20 13:29:07 +01:00
8f12b35976
codingStyleGuide: Improved formatting
...
Resolves bug-report http://bugs.openfoam.org/view.php?id=2194
2016-08-20 09:33:11 +01:00
eaae7ef4e6
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
20da433202
Doxygen: Updated header
2016-06-23 16:06:12 +01:00
fc82c47ede
Doxygen: Cleanup 'dot' files
2016-06-23 16:05:19 +01:00
18147a1aa1
doc/Doxygen/customdoxygen.css: simplified
2016-06-21 11:04:50 +01:00
cf89a3094a
Updated and simplified the Doxygen documentation
2016-06-20 21:20:28 +01:00
9f67acdc53
Updated header documentation processed by Doxygen
2016-06-19 21:23:54 +01:00
4500971827
Further standardization of loop index naming: pointI -> pointi, patchI -> patchi
2016-05-18 21:20:42 +01:00
7cb36e7f3f
codingStyleGuide: Corrected sectioning
2016-04-20 10:33:19 +01:00
30a46904e5
doc/codingStyleGuide.org: Added specification references in class headers
2016-04-19 10:02:14 +01:00
2c2a7f5b97
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
40ccb21eb3
doc/Doxygen/_Footer: Updated copyright date
...
Patch contributed by Bruno Santos
2016-04-16 09:54:21 +01:00
2c2c6efe63
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
7037737d03
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
fa0656c358
scripts: Reformat with consistent section separators
2016-02-15 18:30:24 +00:00
94c05a1e6c
Update code to use the simpler C++11 template syntax removing spaces between closing ">"s
2016-01-10 22:41:16 +00:00
2781d583d9
Updated Guides to v3.0.1
2015-12-15 11:16:49 +00:00
5e6a7ea282
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
571c321da3
Doxyfile: Upgraded for Doxygen-1.8.10
2015-10-30 21:38:06 +00:00
25ab8a1a07
codingStyleGuide: Minor updates
2015-02-25 10:55:51 +00:00
74a8a6f996
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
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
bc5134a55e
New version of wmake supporting out-of-tree object and dependency files
2014-12-14 21:42:18 +00:00
