zhyang-dev/OpenFOAM-6
1
0
Fork 0
mirror of https://github.com/OpenFOAM/OpenFOAM-6.git synced 2025-12-08 06:57:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

codingStyleGuide: Corrected typos

Browse Source 
Patch contributed by Bruno Santos
Resolves bug-report http://bugs.openfoam.org/view.php?id=2193
This commit is contained in:
Henry Weller
2016-08-16 08:36:36 +01:00
parent 14470c0dda
commit eaae7ef4e6
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/codingStyleGuide.org
View File

@ -138,7 +138,7 @@
+ Use inline functions where appropriate in a separate /classNameI.H/ + Use inline functions where appropriate in a separate /classNameI.H/
file. Avoid cluttering the header file with function bodies. file. Avoid cluttering the header file with function bodies.
*** The /.C/ Sourcs Files *** The /.C/ Source Files
+ Do not open/close namespaces in a /.C/ file + Do not open/close namespaces in a /.C/ file
+ Fully scope the function name, i.e. + Fully scope the function name, i.e.
#+begin_src C++ #+begin_src C++
@ -415,7 +415,7 @@
Doxygen has a large number of special commands with a =\= prefix. Doxygen has a large number of special commands with a =\= prefix.
Since the filtering removes the leading spaces within the blocks, the Since the filtering removes the leading spaces within the blocks, the
Doxygen commmands can be inserted within the block without problems. Doxygen commands can be inserted within the block without problems.
#+begin_example C++ #+begin_example C++
InClass InClass
Foam::myClass Foam::myClass
@ -452,7 +452,7 @@
unknown html type, but it seems to work okay anyhow. unknown html type, but it seems to work okay anyhow.
*** Documenting Namespaces *** Documenting Namespaces
+ If namespaces are explictly declared with the =Namespace()= macro, + If namespaces are explicitly declared with the =Namespace()= macro,
they should be documented there. they should be documented there.
+ If the namespaces is used to hold sub-models, the namespace can be + If the namespaces is used to hold sub-models, the namespace can be
documented in the same file as the class with the model selector. documented in the same file as the class with the model selector.