zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

BUG: corrected erroneous use of \f doxygen command

Browse Source
This commit is contained in:
andy
2012-07-12 17:08:30 +01:00
parent 3eddf5d904
commit 6b37816808
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/OpenFOAM/db/dictionary/functionEntries/codeStream/codeStream.H
View File

@ -29,12 +29,12 @@ Description
generate the entry itself. So generate the entry itself. So
- codeStream reads three entries: 'code', 'codeInclude' (optional), - codeStream reads three entries: 'code', 'codeInclude' (optional),
'codeOptions' (optional) 'codeOptions' (optional)
and uses those to generate library sources inside \f codeStream/ and uses those to generate library sources inside \c codeStream/
- these get compiled using 'wmake libso' - these get compiled using 'wmake libso'
- the resulting library is loaded in executed with as arguments - the resulting library is loaded in executed with as arguments
\code \code
(const dictionary& dict, Ostream& os) (const dictionary& dict, Ostream& os)
\endcode \endcode
where the dictionary is the current dictionary. where the dictionary is the current dictionary.
- the code has to write into Ostream which is then used to construct - the code has to write into Ostream which is then used to construct
the actual dictionary entry. the actual dictionary entry.
@ -77,12 +77,12 @@ Description
\c \$ and \c ~ sequences) \c \$ and \c ~ sequences)
Note Note
The code to be compiled is stored under the local \f codeStream directory The code to be compiled is stored under the local \c codeStream directory
with a subdirectory name corresponding to the SHA1 of the contents. with a subdirectory name corresponding to the SHA1 of the contents.
The corresponding library code is located under the local The corresponding library code is located under the local
\f codeStream/platforms/$WM_OPTIONS/lib directory in a library \c codeStream/platforms/$WM_OPTIONS/lib directory in a library
\f libcodeStream_SHA1.so \c libcodeStream_SHA1.so
SourceFiles SourceFiles
codeStream.C codeStream.C