Commit Graph

30 Commits

Author SHA1 Message Date
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
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
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
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
3dbd39146c STYLE: consistency updates 2016-09-27 15:17:55 +01:00
0ea2023ae0 codingStyleGuide: Improved formatting
Resolves bug-report http://bugs.openfoam.org/view.php?id=2194
2016-08-20 09:33:11 +01:00
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
3990302a54 Updated and simplified the Doxygen documentation 2016-06-20 21:20:28 +01:00
71fdcab771 Updated header documentation processed by Doxygen 2016-06-19 21:23:54 +01:00
67de20df25 Further standardization of loop index naming: pointI -> pointi, patchI -> patchi 2016-05-18 21:20:42 +01:00
3639f36d37 codingStyleGuide: Corrected sectioning 2016-04-20 10:33:19 +01:00
a1f209c482 doc/codingStyleGuide.org: Added specification references in class headers 2016-04-19 10:02:14 +01:00
56fa7c0906 Update code to use the simpler C++11 template syntax removing spaces between closing ">"s 2016-01-10 22:41:16 +00:00
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
99b99a46d4 codingStyleGuide: Minor updates 2015-02-25 10:55:51 +00:00
c2dd153a14 Copyright transfered to the OpenFOAM Foundation 2011-08-14 12:17:30 +01:00
742fa75985 ENH: Updated web address 2011-06-14 12:53:43 +01:00
a3d18c648b codingStyleGuide: Added more details about Doxygen documentation 2011-02-09 12:37:33 +00:00
8ca3ebc569 Documentation: Updated style guide 2011-02-08 18:28:13 +00:00
51e2e6160d Documentation: Updated style guide 2011-02-08 18:25:44 +00:00
47c897577d Documentation: Updated style guide 2011-02-08 18:25:16 +00:00
c3cb632c24 Documentation: converted javadoc @ to LaTeX style \ in Doxygen code docs 2011-02-08 18:22:00 +00:00
35d3be771e STYLE: fix spelling, backslashes etc. in codingStyleGuide.org
- now passes through LaTeX with fewer complaints.

- added note about braces for 'case' statements.

- could not formulate a sensible rule about when return statements
  need parentheses and when not.

- did not update codingStyleGuide.pdf ... I don't even know if it
  should be part of the git repo at all
2010-06-01 10:19:11 +02:00
49ccf0ffaa codingStyleGuide: updated and generated the pdf version. GUIDELINES removed. 2010-05-20 09:58:35 +01:00
5636df2b5a STYLE: use #+BEGIN_EXAMPLE / #+END_EXAMPLE in codingStyleGuide.org
- seems to work more reliably than the previous indented colons
2010-04-13 09:08:43 +02:00
b6f3bd4c23 STYLE: follow coding guide recommendation for '//- Destructor' 2010-04-12 11:55:52 +02:00
909e6b27e4 Apply coding style recommendations:
- space between keyword and bracket in 'for(..)', 'if(..)', 'while(..)'
2009-11-30 08:55:03 +01:00
6f14809234 Copy some of GUIDELINES -> codingStyleGuide.org
- use ':' to prefix verbatim code instead of #+BEGIN_EXAMPLE / #+END_EXAMPLE
  for a somewhat better feeling for the indentation.
2009-11-27 16:59:28 +01:00
fa93ce8cd7 coding style adherence
- markup codingStyleGuide.org examples so they actually indent correctly

- use 'Info<<' as per codingStyleGuide instead of 'Info <<'
2009-11-27 15:39:14 +01:00
d8cf3901d3 added doc/codingStyleGuide.org for central revision 2009-10-27 13:55:25 +01:00