Commit Graph

120 Commits

Author SHA1 Message Date
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
5339d687a4 doxygen/Doxyfile: Reformatted 2011-02-08 12:36:49 +00:00
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
83a2a83160 ENH: staticLinkage.txt : how to link static 2011-02-02 11:25:06 +00:00
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
6bb8d56a09 ENH: pointAndEdgeSync : explanation about point sync 2011-01-20 14:24:07 +00:00
eaef8d482b STYLE: Updated 1991 start copyright year to 2004 2011-01-14 16:08:00 +00:00
14d1300a36 Revert "STyLE: More 2011 copyright dates (non-code)."
This reverts commit 2e1e671d96.
2011-01-05 18:25:32 +00:00
2e1e671d96 STyLE: More 2011 copyright dates (non-code). 2011-01-05 11:48:24 +00:00
e2db4e630e Merge remote branch 'bundle/home' into olesenm 2011-01-03 10:06:56 +01:00
2c51cc509d ENH: inotify.txt : update 2010-12-02 18:45:35 +00:00
b5dddd8980 ENH: parallel runTimeModifiable - master only 2010-11-16 12:41:44 +00:00
fd2f0a13d8 Merge remote branch 'bundle/olesenm' into home 2010-11-08 17:22:21 +01:00
cb6b445bbc STYLE: minor css tweaks 2010-11-08 17:22:13 +01:00
df4dc659d7 ENH: ReleaseNotes-dev : update 2010-10-22 13:09:13 +01:00
850fa066d3 ENH: add UList typedefs for the various List counterparts
- eg,
    labelUList  <-> labelList
    scalarUList <-> scalarList
    ...

Note the unallocLabelList typedef is still available.
However labelUList requires less typing (10 vs. 17 chars) and has a
more obvious to labelList.
2010-10-13 10:43:16 +02:00
2b7f905fbd ENH: splitCyclics.txt : updated 2010-10-06 12:06:52 +01:00
7ec390d23d Merge branch 'olesenm' 2010-10-04 11:08:48 +01:00
fbf4d9ec10 Reorganised documentation 2010-09-29 22:09:17 +01:00
0f57f4ec8a STYLE: move bin/doxyFilt -> bin/tools/doxyFilter
- normally only for doxygen generation, not needed in the path
2010-08-11 11:03:43 +02:00
fef1613ed9 ENH: add bin/tool/find-trailingwhitespace 2010-08-03 17:37:14 +02:00
49a853116a STYLE: copyright and 80 char line fixes. 2010-07-27 15:45:43 +01:00
28b1a9e2c6 Merge branch 'olesenm' 2010-06-03 10:25:03 +01:00
f1ee573aa0 Merge branch 'inotify'
Conflicts:
	TODO
2010-06-02 10:10:52 +01:00
6f34c75d92 update 2010-06-01 15:49:00 +01:00
18925e6ee0 ENH: added fileMonitor class (uses inotify) 2010-05-28 15:20:55 +01:00
1a2973c4f4 ENH: added to splitCyclic.txt changes file. 2010-05-21 16:54:55 +01:00
49ccf0ffaa codingStyleGuide: updated and generated the pdf version. GUIDELINES removed. 2010-05-20 09:58:35 +01:00
706594791e Removed Mattijs specific unitTestCases directory and moved CHANGES-splitCyclic into the doc/changes directory. 2010-05-20 09:39:06 +01: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
1668cb76f1 STYLE: reduce number of absolute widths in css
- use &reg; instead of ® in html templates - seems to work better with
  doxygen at the moment
2010-05-10 08:56:50 +02:00
15e9f0ed91 STYLE: adjust doxygen css for better spacing in the navpath 2010-05-06 07:48:08 +02:00
20e9505b69 ENH: first reasonable draft of new doxygen look 2010-05-02 12:02:45 +02:00
1fe136869e ENH: update Doxyfile to 1.6.3 2010-04-16 19:27:39 +02:00
0b7dc317fa ENH: begin reworking doxygen to use xhtml/css and new OpenCFD look
- drop old table-based formatting in favour of div.
- use single css with @import to minimize the impact of style changes
  on the html documents themselves.
- separate css/ directory
- locate css graphic elements inside the css/ directory for easier
  relative addressing.
2010-04-16 08:57:04 +02:00
74b6885674 STYLE: change "it's" to "it is" 2010-04-14 11:39:55 +02:00
6a48570c20 STYLE: add quotes around html attributes 2010-04-14 09:41:52 +02:00
bbb22dc331 ENH: remove existing doxygen html/ in background 2010-04-14 09:14:49 +02: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
d29c438657 STYLE: use url for FSF license instead of postal address, switch to GPL v3 2010-03-29 14:07:56 +02:00
024e573744 STYLE: add OpenFOAM icon to Doxygen pages 2010-02-16 18:55:27 +01:00
f5918e7eb0 DOCU: add Doxygen @mainpage information (in foamVersion.H)
- also update links from opencfd.co.uk -> openfoam.com
2010-02-16 18:32:17 +01:00
909e6b27e4 Apply coding style recommendations:
- space between keyword and bracket in 'for(..)', 'if(..)', 'while(..)'
2009-11-30 08:55:03 +01:00
a51f8d3534 Merge commit 'bundle/home' into olesenm 2009-11-30 08:12:04 +01:00
9b92e3c451 use absolute path for header/footer in Doxyfile
- makes it easier to copy Doxyfile for local Doxygen generation
  ie, for debugging and writing without processing everything
2009-11-29 12:08:27 +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