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

Make Doxygen documentation consistent with the rest of OpenFOAM

Browse Source
This commit is contained in:
Henry Weller
2015-10-29 22:40:41 +00:00
parent 15d700a966
commit f623ba2542
6 changed files with 137 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
src/OpenFOAM/containers/Lists/UList/UList.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -395,49 +395,40 @@ inline void reverse(UList<T>&);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
/** //- Loop across all elements in \a list
* \def forAll(list, i) // \par Usage
* Loop across all elements in \a list // \code
* \par Usage // forAll(anyList, i)
* \code // {
* forAll(anyList, i) // statements;
* { // }
* statements; // \endcode
* } // \sa forAllReverse
* \endcode
* \sa forAllReverse
*/
/**
* \def forAllReverse(list, i)
* Reverse loop across all elements in \a list
* \par Usage
* \code
* forAllReverse(anyList, i)
* {
* statements;
* }
* \endcode
* \sa forAll
*/
#define forAll(list, i) \ #define forAll(list, i) \
for (Foam::label i=0; i<(list).size(); i++) for (Foam::label i=0; i<(list).size(); i++)
//- Reverse loop across all elements in \a list
// \par Usage
// \code
// forAllReverse(anyList, i)
// {
// statements;
// }
// \endcode
// \sa forAll
#define forAllReverse(list, i) \ #define forAllReverse(list, i) \
for (Foam::label i=(list).size()-1; i>=0; i--) for (Foam::label i=(list).size()-1; i>=0; i--)
/** //- Iterate across all elements in the \a container object of type
* \def forAllIter(Container, container, iter) // \a Container.
* Iterate across all elements in the \a container object of type // \par Usage
* \a Container. // \code
* \par Usage // forAll(ContainerType, container, iter)
* \code // {
* forAll(ContainerType, container, iter) // statements;
* { // }
* statements; // \endcode
* } // \sa forAllConstIter
* \endcode
* \sa forAllConstIter
*/
#define forAllIter(Container,container,iter) \ #define forAllIter(Container,container,iter) \
for \ for \
( \ ( \
@ -446,19 +437,16 @@ inline void reverse(UList<T>&);
++iter \ ++iter \
) )
/** //- Iterate across all elements in the \a container object of type
* \def forAllConstIter(Container, container, iter) // \a Container with const access.
* Iterate across all elements in the \a container object of type // \par Usage
* \a Container with const access. // \code
* \par Usage // forAllConstIter(ContainerType, container, iter)
* \code // {
* forAllConstIter(ContainerType, container, iter) // statements;
* { // }
* statements; // \endcode
* } // \sa forAllIter
* \endcode
* \sa forAllIter
*/
#define forAllConstIter(Container,container,iter) \ #define forAllConstIter(Container,container,iter) \
for \ for \
( \ ( \

2
src/OpenFOAM/db/Time/timeSelector.H
View File

@ -162,7 +162,7 @@ public:
//- Return the set of times selected based on the argList options //- Return the set of times selected based on the argList options
// including support for \b -newTimes in which times are selected // including support for \b -newTimes in which times are selected
// if the file <fName> does not exist in the time directory. // if the file 'fName' does not exist in the time directory.
// Also set the runTime to the first instance or the // Also set the runTime to the first instance or the
// \c constant/ directory if no instances are specified or available // \c constant/ directory if no instances are specified or available
static instantList select static instantList select

15
src/OpenFOAM/db/error/StaticAssert.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -62,19 +62,18 @@ class StaticAssertionTest {};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// internal use: // Internal use:
// ~~~~~~~~~~~~~ // ~~~~~~~~~~~~~
// paste together strings, even if an argument is itself a macro
// Paste together strings, even if an argument is itself a macro
#define StaticAssertMacro(X,Y) StaticAssertMacro1(X,Y) #define StaticAssertMacro(X,Y) StaticAssertMacro1(X,Y)
#define StaticAssertMacro1(X,Y) StaticAssertMacro2(X,Y) #define StaticAssertMacro1(X,Y) StaticAssertMacro2(X,Y)
#define StaticAssertMacro2(X,Y) X##Y #define StaticAssertMacro2(X,Y) X##Y
// external use: // External use:
// ~~~~~~~~~~~~~ // ~~~~~~~~~~~~~
/**
* \def StaticAssert(Test) //- Assert that some test is true at compile-time
* Assert that some test is true at compile-time
*/
#define StaticAssert(Test) \ #define StaticAssert(Test) \
typedef ::Foam::StaticAssertionTest \ typedef ::Foam::StaticAssertionTest \
< \ < \

71
src/OpenFOAM/db/error/error.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -310,46 +310,41 @@ extern IOerror FatalIOError;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Convenience macros to add the file name and line number to the function name // Convenience macros to add the file name and line number to the function name
/** //- Report an error message using Foam::FatalError
* \def FatalErrorIn(functionName) // for functionName in file __FILE__ at line __LINE__
* Report an error message using Foam::FatalError for functionName in #define FatalErrorIn(functionName) \
* file __FILE__ at line __LINE__ ::Foam::FatalError((functionName), __FILE__, __LINE__)
*/
#define FatalErrorIn(fn) \
::Foam::FatalError((fn), __FILE__, __LINE__)
/** //- Report an error message using Foam::FatalIOError
* \def FatalIOErrorIn(functionName, ios) // for functionName in file __FILE__ at line __LINE__
* Report an error message using Foam::FatalIOError for functionName in // for a particular IOstream
* file __FILE__ at line __LINE__ #define FatalIOErrorIn(functionName, ios) \
* for a particular IOstream ::Foam::FatalIOError((functionName), __FILE__, __LINE__, (ios))
*/
#define FatalIOErrorIn(fn, ios) \
::Foam::FatalIOError((fn), __FILE__, __LINE__, (ios))
/** //- Report an error message using Foam::FatalIOError
* \def SafeFatalIOErrorIn(functionName, ios, msg) // (or cerr if FatalIOError not yet constructed)
* Report an error message using Foam::FatalIOError (or cerr if FatalIOError // for functionName in file __FILE__ at line __LINE__
* not yet constructed) for functionName in // for a particular IOstream
* file __FILE__ at line __LINE__ #define SafeFatalIOErrorIn(functionName, ios, msg) \
* for a particular IOstream ::Foam::IOerror::SafeFatalIOError \
*/ ((functionName), __FILE__, __LINE__, (ios), (msg))
#define SafeFatalIOErrorIn(fn, ios, msg) \
::Foam::IOerror::SafeFatalIOError((fn), __FILE__, __LINE__, (ios), (msg)) //- Issue a FatalErrorIn for a function not currently implemented.
// The functionName is printed and then abort is called.
//
// This macro can be particularly useful when methods must be defined to
// complete the interface of a derived class even if they should never be
// called for this derived class.
#define notImplemented(functionName) \
FatalErrorIn(functionName) \
<< "Not implemented" << ::Foam::abort(FatalError);
//- Issue a FatalErrorIn for a function not currently implemented.
// The compiler generated function name string is printed and then
// abort is called.
#define NotImplemented \
notImplemented(__PRETTY_FUNCTION__)
/**
* \def notImplemented(functionName)
* Issue a FatalErrorIn for the functionName.
* This is used for functions that are not currently implemented.
* The functionName is printed and then abort is called.
*
* \note
* This macro can be particularly useful when methods must be defined to
* complete the interface of a derived class even if they should never be
* called for this derived class.
*/
#define notImplemented(fn) \
FatalErrorIn(fn) << "Not implemented" << ::Foam::abort(FatalError);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

57
src/OpenFOAM/db/error/messageStream.H
View File

@ -218,65 +218,44 @@ extern messageStream Info;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Convenience macros to add the file name and line number to the function name // Convenience macros to add the file name and line number to the function name
/** //- Report an error message using Foam::SeriousError
* \def SeriousErrorIn(functionName) // for functionName in file __FILE__ at line __LINE__
* Report an error message using Foam::SeriousError for functionName in
* file __FILE__ at line __LINE__
*/
#define SeriousErrorIn(fn) \ #define SeriousErrorIn(fn) \
::Foam::SeriousError((fn), __FILE__, __LINE__) ::Foam::SeriousError((fn), __FILE__, __LINE__)
/** //- Report an IO error message using Foam::SeriousError
* \def SeriousIOErrorIn(functionName, ios) // for functionName in file __FILE__ at line __LINE__
* Report an IO error message using Foam::SeriousError for functionName in // for a particular IOstream
* file __FILE__ at line __LINE__
* for a particular IOstream
*/
#define SeriousIOErrorIn(fn, ios) \ #define SeriousIOErrorIn(fn, ios) \
::Foam::SeriousError((fn), __FILE__, __LINE__, ios) ::Foam::SeriousError((fn), __FILE__, __LINE__, ios)
/** //- Report a warning using Foam::Warning
* \def WarningIn(functionName) // for functionName in file __FILE__ at line __LINE__
* Report a warning using Foam::Warning for functionName in
* file __FILE__ at line __LINE__
*/
#define WarningIn(fn) \ #define WarningIn(fn) \
::Foam::Warning((fn), __FILE__, __LINE__) ::Foam::Warning((fn), __FILE__, __LINE__)
/** //- Report an IO warning using Foam::Warning
* \def IOWarningIn(functionName, ios) // for functionName in file __FILE__ at line __LINE__
* Report an IO warning using Foam::Warning for functionName in // for a particular IOstream
* file __FILE__ at line __LINE__
* for a particular IOstream
*/
#define IOWarningIn(fn, ios) \ #define IOWarningIn(fn, ios) \
::Foam::Warning((fn), __FILE__, __LINE__, (ios)) ::Foam::Warning((fn), __FILE__, __LINE__, (ios))
/** //- Report a information message using Foam::Info
* \def InfoIn(functionName) // for functionName in file __FILE__ at line __LINE__
* Report a information message using Foam::Info for functionName in
* file __FILE__ at line __LINE__
*/
#define InfoIn(fn) \ #define InfoIn(fn) \
::Foam::Info((fn), __FILE__, __LINE__) ::Foam::Info((fn), __FILE__, __LINE__)
/** //- Report an IO information message using Foam::Info
* \def IOInfoIn(functionName, ios) // for functionName in file __FILE__ at line __LINE__
* Report an IO information message using Foam::Info for functionName in // for a particular IOstream
* file __FILE__ at line __LINE__
* for a particular IOstream
*/
#define IOInfoIn(fn, ios) \ #define IOInfoIn(fn, ios) \
::Foam::Info((fn), __FILE__, __LINE__, (ios)) ::Foam::Info((fn), __FILE__, __LINE__, (ios))
/** //- Report a variable name and value
* \def Debug(variable) // using Foam::Pout in file __FILE__ at line __LINE__
* Report a variable name and value using Foam::Pout in
* file __FILE__ at line __LINE__
*/
#define Debug(var) \ #define Debug(var) \
::Foam::Pout<< "["<< __FILE__ << ":" << __LINE__ << "] " \ ::Foam::Pout<< "["<< __FILE__ << ":" << __LINE__ << "] " \
<< #var " = " << var << ::Foam::endl << #var " " << var << ::Foam::endl
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

68
src/OpenFOAM/memory/Xfer/Xfer.H
View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation \\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
License License
@ -90,6 +90,7 @@ class Xfer
//- Pointer to underlying datatype //- Pointer to underlying datatype
mutable T* ptr_; mutable T* ptr_;
public: public:
// Constructors // Constructors
@ -107,14 +108,17 @@ public:
//- Construct by transferring the contents //- Construct by transferring the contents
inline Xfer(const Xfer<T>&); inline Xfer(const Xfer<T>&);
//- Destructor //- Destructor
inline ~Xfer(); inline ~Xfer();
// Member Functions // Member Functions
//- Return a null object reference //- Return a null object reference
inline static const Xfer<T>& null(); inline static const Xfer<T>& null();
// Member Operators // Member Operators
//- Transfer the contents into the object //- Transfer the contents into the object
@ -128,67 +132,57 @@ public:
//- Pointer to the underlying datatype //- Pointer to the underlying datatype
inline T* operator->() const; inline T* operator->() const;
}; };
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
/** //- Construct by copying the contents of the \a arg
* Construct by copying the contents of the \a arg //
* // \sa xferCopyTo, xferMove, xferMoveTo, xferTmp and Foam::Xfer
* \sa xferCopyTo, xferMove, xferMoveTo, xferTmp and Foam::Xfer
*/
template<class T> template<class T>
inline Xfer<T> xferCopy(const T&); inline Xfer<T> xferCopy(const T&);
/** //- Construct by transferring the contents of the \a arg
* Construct by transferring the contents of the \a arg //
* // \sa xferCopy, xferCopyTo, xferMoveTo, xferTmp and Foam::Xfer
* \sa xferCopy, xferCopyTo, xferMoveTo, xferTmp and Foam::Xfer
*/
template<class T> template<class T>
inline Xfer<T> xferMove(T&); inline Xfer<T> xferMove(T&);
/** //- Construct by transferring the contents of the \a arg
* Construct by transferring the contents of the \a arg //
* // \sa xferCopy, xferCopyTo, xferMove, xferMoveTo and Foam::Xfer
* \sa xferCopy, xferCopyTo, xferMove, xferMoveTo and Foam::Xfer
*/
template<class T> template<class T>
inline Xfer<T> xferTmp(Foam::tmp<T>&); inline Xfer<T> xferTmp(Foam::tmp<T>&);
/** //- Construct by copying the contents of the \a arg
* Construct by copying the contents of the \a arg // between dissimilar types
* between dissimilar types //
* // \sa xferCopy, xferMove, xferMoveTo, xferTmp and Foam::Xfer
* \sa xferCopy, xferMove, xferMoveTo, xferTmp and Foam::Xfer
*/
template<class To, class From> template<class To, class From>
inline Xfer<To> xferCopyTo(const From&); inline Xfer<To> xferCopyTo(const From&);
/** //- Construct by transferring the contents of the \a arg
* Construct by transferring the contents of the \a arg // between dissimilar types
* between dissimilar types //
* // \par Example Use
* \par Example Use // \code
* \code // DynamicList<label> dynLst;
* DynamicList<label> dynLst; // ...
* ... // labelList plainLst( xferMoveTo<labelList>(dynLst) );
* labelList plainLst( xferMoveTo<labelList>(dynLst) ); // \endcode
* \endcode //
* // \sa xferCopy, xferCopyTo, xferMove, xferTmp and Foam::Xfer
* \sa xferCopy, xferCopyTo, xferMove, xferTmp and Foam::Xfer
*/
template<class To, class From> template<class To, class From>
inline Xfer<To> xferMoveTo(From&); inline Xfer<To> xferMoveTo(From&);
} // End namespace Foam // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //