... | ... | @@ -302,7 +302,7 @@ For many more details see the |
|
|
}
|
|
|
```
|
|
|
Note that when indexing through iterators, it is often more efficient
|
|
|
to use the pre-increment form. Eg, =++iter= instead of =iter++=
|
|
|
to use the pre-increment form. Eg, `++iter` instead of `iter++`
|
|
|
|
|
|
+ `forAll`, `forAllIters`, `forAllConstIters`, /etc./ loops
|
|
|
Like `for` loops, but
|
... | ... | @@ -356,7 +356,7 @@ For many more details see the |
|
|
longFunctionName const
|
|
|
```
|
|
|
+ If it needs to be split again, split at the function name (leaving
|
|
|
behind the preceding scoping =::=s), and again, left align, i.e.
|
|
|
behind the preceding scoping `::`s), and again, left align, i.e.
|
|
|
```
|
|
|
const Foam::longReturnTypeName&
|
|
|
Foam::veryveryveryverylongClassName::
|
... | ... | @@ -514,19 +514,19 @@ Description |
|
|
\endcode
|
|
|
```
|
|
|
|
|
|
####* HTML Special Commands
|
|
|
#### HTML Special Commands
|
|
|
|
|
|
Since Doxygen also handles HTML tags to a certain extent, the angle
|
|
|
brackets need quoting in the documentation blocks. Non-HTML tags cause
|
|
|
Doxygen to complain, but seem to work anyhow. For example,
|
|
|
+ The template with type =<HR>= is a bad example.
|
|
|
+ The template with type =\<HR\>= is a better example.
|
|
|
+ The template with type =<Type>= causes Doxygen to complain about an
|
|
|
+ The template with type `<HR>` is a bad example.
|
|
|
+ The template with type `\<HR\>` is a better example.
|
|
|
+ The template with type `<Type>` causes Doxygen to complain about an
|
|
|
unknown html type, but it seems to work okay anyhow.
|
|
|
|
|
|
#### Documenting Namespaces
|
|
|
|
|
|
+ If namespaces are explicitly declared with the =Namespace()= macro,
|
|
|
+ If namespaces are explicitly declared with the `Namespace()` macro,
|
|
|
they should be documented there.
|
|
|
+ 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.
|
... | ... | @@ -573,8 +573,8 @@ myClass.initialize() |
|
|
#### References
|
|
|
|
|
|
References provided in the `Description` section of the class header files
|
|
|
should be formatted in the [[http://www.apastyle.org][APA (American
|
|
|
Psychological Association)]] style. Example from `kEpsilon.H`
|
|
|
should be formatted in the [APA (American
|
|
|
Psychological Association)](http://www.apastyle.org) style. Example from `kEpsilon.H`
|
|
|
```
|
|
|
Description
|
|
|
Standard k-epsilon turbulence model for incompressible and compressible
|
... | ... | |