From de487f0f0a9663f698b52e9b291be78b1381c350 Mon Sep 17 00:00:00 2001
From: Mark Olesen <Mark.Olesen@esi-group.com>
Date: Thu, 22 Aug 2019 12:28:04 +0200
Subject: [PATCH] STYLE: improve some descriptions (#1405)
---
.../reactingMultiphaseEulerFoam.C | 2 +-
.../reactingTwoPhaseEulerFoam.C | 2 +-
src/OpenFOAM/memory/autoPtr/autoPtr.H | 15 ++++++++-------
3 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
index 27d86efc6fa..913307e4251 100644
--- a/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
+++ b/applications/solvers/multiphase/reactingEulerFoam/reactingMultiphaseEulerFoam/reactingMultiphaseEulerFoam.C
@@ -31,7 +31,7 @@ Description
common pressure, but otherwise separate properties. The type of phase model
is run time selectable and can optionally represent multiple species and
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.
\*---------------------------------------------------------------------------*/
diff --git a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
index e8112a3e896..80f1a3253cb 100644
--- a/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
+++ b/applications/solvers/multiphase/reactingEulerFoam/reactingTwoPhaseEulerFoam/reactingTwoPhaseEulerFoam.C
@@ -34,7 +34,7 @@ Description
but otherwise separate properties. The type of phase model is run time
selectable and can optionally represent multiple species and in-phase
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.
\*---------------------------------------------------------------------------*/
diff --git a/src/OpenFOAM/memory/autoPtr/autoPtr.H b/src/OpenFOAM/memory/autoPtr/autoPtr.H
index fd7598be842..fd8d48f42ba 100644
--- a/src/OpenFOAM/memory/autoPtr/autoPtr.H
+++ b/src/OpenFOAM/memory/autoPtr/autoPtr.H
@@ -191,6 +191,7 @@ public:
// Other
//- Construct copy by invoking clone on underlying managed object
+ // A no-op if no pointer is managed
// \param args list of arguments for clone
template<class... Args>
inline autoPtr<T> clone(Args&&... args) const;
@@ -199,31 +200,31 @@ public:
// Member Operators
//- Return reference to the managed object.
- // Fatal error if no pointer is managed
+ // FatalError if no pointer is managed
inline T& operator*();
//- Return const reference to the object.
- // Fatal error if no pointer is managed
+ // FatalError if no pointer is managed
inline const T& operator*() const;
//- Dereferences (non-const) pointer to the managed object
- // Fatal error if no pointer is managed
+ // FatalError if no pointer is managed
inline T* operator->();
//- 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;
//- Return reference to the object data.
- // Fatal error if no pointer is managed
+ // FatalError if no pointer is managed
inline T& operator()();
//- 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;
//- 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
// where the user should really know or check if the pointer
// is valid prior to using.
--
GitLab