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

STYLE: improve some descriptions (#1405)

Browse Source
This commit is contained in:
Mark Olesen
2019-08-22 12:28:04 +02:00
committed by Andrew Heather
parent ccaad99f52
commit de487f0f0a
3 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
View File

@ -31,7 +31,7 @@ Description
common pressure, but otherwise separate properties. The type of phase model common pressure, but otherwise separate properties. The type of phase model
is run time selectable and can optionally represent multiple species and is run time selectable and can optionally represent multiple species and
in-phase reactions. The phase system is also run time selectable and can in-phase reactions. The phase system is also run time selectable and can
optionally represent different types of momentun, heat and mass transfer. optionally represent different types of momentum, heat and mass transfer.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

2
applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
View File

@ -34,7 +34,7 @@ Description
but otherwise separate properties. The type of phase model is run time but otherwise separate properties. The type of phase model is run time
selectable and can optionally represent multiple species and in-phase selectable and can optionally represent multiple species and in-phase
reactions. The phase system is also run time selectable and can optionally reactions. The phase system is also run time selectable and can optionally
represent different types of momentun, heat and mass transfer. represent different types of momentum, heat and mass transfer.
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

15
src/OpenFOAM/memory/autoPtr/autoPtr.H
View File

@ -191,6 +191,7 @@ public:
// Other // Other
//- Construct copy by invoking clone on underlying managed object //- Construct copy by invoking clone on underlying managed object
// A no-op if no pointer is managed
// \param args list of arguments for clone // \param args list of arguments for clone
template<class... Args> template<class... Args>
inline autoPtr<T> clone(Args&&... args) const; inline autoPtr<T> clone(Args&&... args) const;
@ -199,31 +200,31 @@ public:
// Member Operators // Member Operators
//- Return reference to the managed object. //- Return reference to the managed object.
// Fatal error if no pointer is managed // FatalError if no pointer is managed
inline T& operator*(); inline T& operator*();
//- Return const reference to the object. //- Return const reference to the object.
// Fatal error if no pointer is managed // FatalError if no pointer is managed
inline const T& operator*() const; inline const T& operator*() const;
//- Dereferences (non-const) pointer to the managed object //- Dereferences (non-const) pointer to the managed object
// Fatal error if no pointer is managed // FatalError if no pointer is managed
inline T* operator->(); inline T* operator->();
//- Dereferences (const) pointer to the managed object //- Dereferences (const) pointer to the managed object
// Fatal error if no pointer is managed // FatalError if no pointer is managed
inline const T* operator->() const; inline const T* operator->() const;
//- Return reference to the object data. //- Return reference to the object data.
// Fatal error if no pointer is managed // FatalError if no pointer is managed
inline T& operator()(); inline T& operator()();
//- Return const reference to the object data //- Return const reference to the object data
// Fatal error if no pointer is managed // FatalError if no pointer is managed
inline const T& operator()() const; inline const T& operator()() const;
//- Deprecated(2019-01) Automatic cast conversion to underlying type //- Deprecated(2019-01) Automatic cast conversion to underlying type
// Fatal error if no pointer is managed // FatalError if no pointer is managed
// \deprecated(2019-01) Can result in inadvertent conversions // \deprecated(2019-01) Can result in inadvertent conversions
// where the user should really know or check if the pointer // where the user should really know or check if the pointer
// is valid prior to using. // is valid prior to using.