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

Doxygen cleanups

Browse Source 
* skip doxygen docs for local variables (treeBoundBox)
  * filter transforms 'Typedef' -> @typedef
  * added tools/find-retagged
  * manually changed some InClass tags to Typedef - still needs more attention
This commit is contained in:
Mark Olesen
2008-06-11 10:05:33 +02:00
parent 6d94d8ed8b
commit e5f0dd3e03
37 changed files with 190 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/OpenFOAM/db/IOstreams/IOstreams/IOstream.H
View File

@ -26,14 +26,14 @@ Class
Foam::IOstream
Description
An IOstream is an abstract base class for all input/output
systems; be they streams, files, token lists etc.
The basic operations are construct, close, read token,
read primitive and read binary block. In addition version control
and line number counting is incorporated. Usually one would use
the read primitive member functions, but if one were reading a
stream on unknown data sequence one can read token by token, and
then analyse.
An IOstream is an abstract base class for all input/output systems; be
they streams, files, token lists etc.
The basic operations are construct, close, read token, read primitive
and read binary block. In addition version control and line number
counting is incorporated. Usually one would use the read primitive
member functions, but if one were reading a stream on unknown data
sequence one can read token by token, and then analyse.
SourceFiles
IOprint.C

4
src/OpenFOAM/db/IOstreams/IOstreams/Ostream.H
View File

@ -154,7 +154,7 @@ public:
//- Flush stream
virtual void flush() = 0;
//- Add '\n' and flush stream
//- Add newline and flush stream
virtual void endl() = 0;
//- Get width of output field
@ -233,7 +233,7 @@ inline Ostream& flush(Ostream& os)
}
//- Add '\n' and flush stream
//- Add newline and flush stream
inline Ostream& endl(Ostream& os)
{
os.endl();