View Issue Details

IDProjectCategoryView StatusLast Update
0000254OpenFOAMBugpublic2011-07-20 16:08
Reporteruser19Assigned Tohenry  
PrioritynormalSeveritytextReproducibilityN/A
Status resolvedResolutionfixed 
Summary0000254: Many header files contain bogus "Class" declarations
DescriptionE.g. the file src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.H contains

Class
    Foam::GeometricField

instead of

Class
    Foam::geometricOneField

Apart from being confusing, this leads to sometimes wrong Doxygen documentation.
Additional InformationAttached patch fixes the issues I could find. Some headers contain a Class section although they contain only macro definitions or template specialisations; I didn't change those.
TagsNo tags attached.

Activities

user19

2011-07-18 16:12

 

0001-DOC-Fix-some-bogus-class-documentation-comments.patch (23,462 bytes)   
From 2e7db3edcc7ee8f1bfca114dfc42b1b5ac16c600 Mon Sep 17 00:00:00 2001
From: Michael Wild <themiwi@users.sourceforge.net>
Date: Mon, 18 Jul 2011 17:06:01 +0200
Subject: [PATCH] DOC: Fix some bogus class documentation comments

Signed-off-by: Michael Wild <themiwi@users.sourceforge.net>
---
 .../threePhaseMixture.C                            |    3 ---
 .../mesh/manipulation/polyDualMesh/meshDualiser.C  |    3 ---
 .../utilities/mesh/manipulation/setSet/writeFuns.H |    8 ++++----
 .../dataConversion/foamToVTK/writeFuns.H           |    8 ++++----
 src/OSspecific/POSIX/fileMonitor.C                 |    3 ---
 src/OpenFOAM/db/error/StaticAssert.H               |    2 +-
 .../geometricOneField/geometricOneField.H          |    2 +-
 .../geometricZeroField/geometricZeroField.H        |    2 +-
 .../interpolationTable/tableReaders/tableReaders.H |    3 ---
 src/OpenFOAM/meshes/polyMesh/zones/zone/zone.H     |    2 +-
 .../basicSource/basicSource/basicSourceList.H      |    2 +-
 src/finiteVolume/fvMatrices/fvMatricesFwd.H        |    8 +-------
 src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H    |    5 ++++-
 .../pureUpwindCFCCellToFaceStencilObject.H         |    2 +-
 .../interpolationCellPointWallModified.H           |    2 +-
 .../mapping/fvFieldMappers/MapFvSurfaceField.H     |    2 +-
 .../mapping/fvFieldMappers/MapFvVolField.H         |    2 +-
 .../displacementFvMotionSolver.H                   |    2 +-
 .../coalCombustion/coalCloud/coalCloud.H           |    2 +-
 .../basicReactingMultiphaseParcel.H                |    2 +-
 .../kinematicParcelInjectionDataIOList.H           |    1 +
 .../Drag/NonSphereDrag/NonSphereDragForce.H        |    2 +-
 .../reactingParcelInjectionDataIOList.H            |    1 +
 .../reactingMultiphaseParcelInjectionDataIOList.H  |    1 +
 .../thermoParcelInjectionDataIOList.H              |    1 +
 .../pairPotential/derived/coulomb/coulomb.H        |    2 +-
 .../derived/dampedCoulomb/dampedCoulomb.H          |    2 +-
 .../field/streamLine/streamLineParticleCloud.H     |    2 +-
 .../basic/rhoThermo/hRhoThermo/hRhoThermo.H        |    2 +-
 .../noChemistrySolver/noChemistrySolver.H          |    2 +-
 .../fvDOM/absorptionCoeffs/absorptionCoeffs.H      |    2 +-
 .../wideBandAbsorptionEmission.H                   |    2 +-
 32 files changed, 37 insertions(+), 48 deletions(-)

diff --git a/applications/solvers/multiphase/interMixingFoam/incompressibleThreePhaseMixture/threePhaseMixture.C b/applications/solvers/multiphase/interMixingFoam/incompressibleThreePhaseMixture/threePhaseMixture.C
index 5edf003..1bf6e43 100644
--- a/applications/solvers/multiphase/interMixingFoam/incompressibleThreePhaseMixture/threePhaseMixture.C
+++ b/applications/solvers/multiphase/interMixingFoam/incompressibleThreePhaseMixture/threePhaseMixture.C
@@ -21,9 +21,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Class
-    threePhaseMixture
-
 \*---------------------------------------------------------------------------*/
 
 #include "threePhaseMixture.H"
diff --git a/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C b/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C
index 2f90994..38e8b78 100644
--- a/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C
+++ b/applications/utilities/mesh/manipulation/polyDualMesh/meshDualiser.C
@@ -21,9 +21,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Class
-    meshDualiser
-
 \*---------------------------------------------------------------------------*/
 
 #include "meshDualiser.H"
diff --git a/applications/utilities/mesh/manipulation/setSet/writeFuns.H b/applications/utilities/mesh/manipulation/setSet/writeFuns.H
index 1b9aef4..5f33f7b 100644
--- a/applications/utilities/mesh/manipulation/setSet/writeFuns.H
+++ b/applications/utilities/mesh/manipulation/setSet/writeFuns.H
@@ -22,18 +22,18 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::writeFunctions
+    Foam::writeFuns
 
 Description
     Various functions for collecting and writing binary data.
 
 SourceFiles
-    writeFunctions.C
+    writeFuns.C
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef writeFunctions_H
-#define writeFunctions_H
+#ifndef writeFuns_H
+#define writeFuns_H
 
 #include "labelList.H"
 #include "floatScalar.H"
diff --git a/applications/utilities/postProcessing/dataConversion/foamToVTK/writeFuns.H b/applications/utilities/postProcessing/dataConversion/foamToVTK/writeFuns.H
index ecd7225..c26ce52 100644
--- a/applications/utilities/postProcessing/dataConversion/foamToVTK/writeFuns.H
+++ b/applications/utilities/postProcessing/dataConversion/foamToVTK/writeFuns.H
@@ -22,18 +22,18 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::writeFunctions
+    Foam::writeFuns
 
 Description
     Various functions for collecting and writing binary data.
 
 SourceFiles
-    writeFunctions.C
+    writeFuns.C
 
 \*---------------------------------------------------------------------------*/
 
-#ifndef writeFunctions_H
-#define writeFunctions_H
+#ifndef writeFuns_H
+#define writeFuns_H
 
 #include "floatScalar.H"
 #include "DynamicList.H"
diff --git a/src/OSspecific/POSIX/fileMonitor.C b/src/OSspecific/POSIX/fileMonitor.C
index cb0e8be..cdf4020 100644
--- a/src/OSspecific/POSIX/fileMonitor.C
+++ b/src/OSspecific/POSIX/fileMonitor.C
@@ -21,9 +21,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Class
-    fileMonitor
-
 \*----------------------------------------------------------------------------*/
 
 #include "fileMonitor.H"
diff --git a/src/OpenFOAM/db/error/StaticAssert.H b/src/OpenFOAM/db/error/StaticAssert.H
index beab97f..5d209d3 100644
--- a/src/OpenFOAM/db/error/StaticAssert.H
+++ b/src/OpenFOAM/db/error/StaticAssert.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::StaticAssertFailed
+    Foam::StaticAssertionFailed
 
 Description
     Macros and classes to provide static (compile-time) assertions.
diff --git a/src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.H b/src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.H
index 76b096c..ff2a760 100644
--- a/src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.H
+++ b/src/OpenFOAM/fields/GeometricFields/geometricOneField/geometricOneField.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::GeometricField
+    Foam::geometricOneField
 
 Description
     A class representing the concept of a GeometricField of 1 used to avoid
diff --git a/src/OpenFOAM/fields/GeometricFields/geometricZeroField/geometricZeroField.H b/src/OpenFOAM/fields/GeometricFields/geometricZeroField/geometricZeroField.H
index ec7c6ff..c42891a 100644
--- a/src/OpenFOAM/fields/GeometricFields/geometricZeroField/geometricZeroField.H
+++ b/src/OpenFOAM/fields/GeometricFields/geometricZeroField/geometricZeroField.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::GeometricField
+    Foam::geometricZeroField
 
 Description
     A class representing the concept of a GeometricField of 1 used to avoid
diff --git a/src/OpenFOAM/interpolations/interpolationTable/tableReaders/tableReaders.H b/src/OpenFOAM/interpolations/interpolationTable/tableReaders/tableReaders.H
index 8e1c8a0..0a9aae4 100644
--- a/src/OpenFOAM/interpolations/interpolationTable/tableReaders/tableReaders.H
+++ b/src/OpenFOAM/interpolations/interpolationTable/tableReaders/tableReaders.H
@@ -21,9 +21,6 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Class
-    Foam::tableReader
-
 SourceFiles
     tableReaders.C
 
diff --git a/src/OpenFOAM/meshes/polyMesh/zones/zone/zone.H b/src/OpenFOAM/meshes/polyMesh/zones/zone/zone.H
index 4f02043..b112b46 100644
--- a/src/OpenFOAM/meshes/polyMesh/zones/zone/zone.H
+++ b/src/OpenFOAM/meshes/polyMesh/zones/zone/zone.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::cellZone
+    Foam::zone
 
 Description
     Base class for zones
diff --git a/src/finiteVolume/cfdTools/general/fieldSources/basicSource/basicSource/basicSourceList.H b/src/finiteVolume/cfdTools/general/fieldSources/basicSource/basicSource/basicSourceList.H
index 02cd801..7cc22e8 100644
--- a/src/finiteVolume/cfdTools/general/fieldSources/basicSource/basicSource/basicSourceList.H
+++ b/src/finiteVolume/cfdTools/general/fieldSources/basicSource/basicSource/basicSourceList.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::basicsourceList
+    Foam::basicSourceList
 
 Description
     List of explict sources
diff --git a/src/finiteVolume/fvMatrices/fvMatricesFwd.H b/src/finiteVolume/fvMatrices/fvMatricesFwd.H
index b86b729..f780449 100644
--- a/src/finiteVolume/fvMatrices/fvMatricesFwd.H
+++ b/src/finiteVolume/fvMatrices/fvMatricesFwd.H
@@ -21,14 +21,8 @@ License
     You should have received a copy of the GNU General Public License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
-Class
-    Foam::fvMatrix
-
 Description
-    A special matrix type and solver, designed for finite volume
-    solutions of scalar equations.
-    Face addressing is used to make all matrix assembly
-    and solution loops vectorise.
+    Forward declarations of fvMatrix specializations.
 
 \*---------------------------------------------------------------------------*/
 
diff --git a/src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H b/src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H
index 773db6d..4763714 100644
--- a/src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H
+++ b/src/finiteVolume/fvMatrices/fvMatrix/fvMatrix.H
@@ -25,7 +25,10 @@ Class
     Foam::fvMatrix
 
 Description
-    Finite-Volume matrix.
+    A special matrix type and solver, designed for finite volume
+    solutions of scalar equations.
+    Face addressing is used to make all matrix assembly
+    and solution loops vectorise.
 
 SourceFiles
     fvMatrix.C
diff --git a/src/finiteVolume/fvMesh/extendedStencil/cellToFace/MeshObjects/pureUpwindCFCCellToFaceStencilObject.H b/src/finiteVolume/fvMesh/extendedStencil/cellToFace/MeshObjects/pureUpwindCFCCellToFaceStencilObject.H
index 4965e2e..fb3959b 100644
--- a/src/finiteVolume/fvMesh/extendedStencil/cellToFace/MeshObjects/pureUpwindCFCCellToFaceStencilObject.H
+++ b/src/finiteVolume/fvMesh/extendedStencil/cellToFace/MeshObjects/pureUpwindCFCCellToFaceStencilObject.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::upwindCFCCellToFaceStencilObject
+    Foam::pureUpwindCFCCellToFaceStencilObject
 
 Description
 
diff --git a/src/finiteVolume/interpolation/interpolation/interpolationCellPointWallModified/interpolationCellPointWallModified.H b/src/finiteVolume/interpolation/interpolation/interpolationCellPointWallModified/interpolationCellPointWallModified.H
index 6b57454..0cb362f 100644
--- a/src/finiteVolume/interpolation/interpolation/interpolationCellPointWallModified/interpolationCellPointWallModified.H
+++ b/src/finiteVolume/interpolation/interpolation/interpolationCellPointWallModified/interpolationCellPointWallModified.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::interpolationCellPoint
+    Foam::interpolationCellPointWallModified
 
 Description
     Same as interpolationCellPoint, but if interpolating a wall face, uses
diff --git a/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvSurfaceField.H b/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvSurfaceField.H
index 21def0d..6f46d37 100644
--- a/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvSurfaceField.H
+++ b/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvSurfaceField.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::MapFvSurfaceField
+    Foam::MapInternalField
 
 Description
     Map Surface internal field on topology change.  This is a partial
diff --git a/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvVolField.H b/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvVolField.H
index ed1ce0f..2017cee 100644
--- a/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvVolField.H
+++ b/src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvVolField.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::MapFvVolField
+    Foam::MapInternalField
 
 Description
     Map volume internal field on topology change.  This is a partial
diff --git a/src/fvMotionSolver/fvMotionSolvers/displacement/displacementFvMotionSolver/displacementFvMotionSolver.H b/src/fvMotionSolver/fvMotionSolvers/displacement/displacementFvMotionSolver/displacementFvMotionSolver.H
index 1f0d7a1..2a29c07 100644
--- a/src/fvMotionSolver/fvMotionSolvers/displacement/displacementFvMotionSolver/displacementFvMotionSolver.H
+++ b/src/fvMotionSolver/fvMotionSolvers/displacement/displacementFvMotionSolver/displacementFvMotionSolver.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::displacementFvMotionSolver.H
+    Foam::displacementFvMotionSolver
 
 Description
     Base class for fvMotionSolvers which calculate displacement.
diff --git a/src/lagrangian/coalCombustion/coalCloud/coalCloud.H b/src/lagrangian/coalCombustion/coalCloud/coalCloud.H
index e3df300..eac53ec 100644
--- a/src/lagrangian/coalCombustion/coalCloud/coalCloud.H
+++ b/src/lagrangian/coalCombustion/coalCloud/coalCloud.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    CoalCloud
+    coalCloud
 
 Description
     Cloud class to introduce coal parcels
diff --git a/src/lagrangian/intermediate/parcels/derived/basicReactingMultiphaseParcel/basicReactingMultiphaseParcel.H b/src/lagrangian/intermediate/parcels/derived/basicReactingMultiphaseParcel/basicReactingMultiphaseParcel.H
index 0289d1c..625e078 100644
--- a/src/lagrangian/intermediate/parcels/derived/basicReactingMultiphaseParcel/basicReactingMultiphaseParcel.H
+++ b/src/lagrangian/intermediate/parcels/derived/basicReactingMultiphaseParcel/basicReactingMultiphaseParcel.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::BasicReactingMultiphaseParcel
+    Foam::basicReactingMultiphaseParcel
 
 Description
     Definition of basic reacting parcel
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/kinematicParcelInjectionDataIOList.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/kinematicParcelInjectionDataIOList.H
index e7adc61..a980652 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/kinematicParcelInjectionDataIOList.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/kinematicParcelInjectionDataIOList.H
@@ -22,6 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
+    kinematicParcelInjectionDataIOList
 
 Description
 
diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/NonSphereDrag/NonSphereDragForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/NonSphereDrag/NonSphereDragForce.H
index f8a1852..a03372c 100644
--- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/NonSphereDrag/NonSphereDragForce.H
+++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/NonSphereDrag/NonSphereDragForce.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::NonSphereDrag
+    Foam::NonSphereDragForce
 
 Description
     Drag model for non-spherical particles.
diff --git a/src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/reactingParcelInjectionDataIOList.H b/src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/reactingParcelInjectionDataIOList.H
index c93bde5..c7bf0ee 100644
--- a/src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/reactingParcelInjectionDataIOList.H
+++ b/src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/reactingParcelInjectionDataIOList.H
@@ -22,6 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
+    Foam::reactingParcelInjectionDataIOList
 
 Description
 
diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/reactingMultiphaseParcelInjectionDataIOList.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/reactingMultiphaseParcelInjectionDataIOList.H
index e041051..f72746f 100644
--- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/reactingMultiphaseParcelInjectionDataIOList.H
+++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/reactingMultiphaseParcelInjectionDataIOList.H
@@ -22,6 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
+    reactingMultiphaseParcelInjectionDataIOList
 
 Description
 
diff --git a/src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/thermoParcelInjectionDataIOList.H b/src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/thermoParcelInjectionDataIOList.H
index 76d39e5..d1abe17 100644
--- a/src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/thermoParcelInjectionDataIOList.H
+++ b/src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/thermoParcelInjectionDataIOList.H
@@ -22,6 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
+    thermoParcelInjectionDataIOList
 
 Description
 
diff --git a/src/lagrangian/molecularDynamics/potential/pairPotential/derived/coulomb/coulomb.H b/src/lagrangian/molecularDynamics/potential/pairPotential/derived/coulomb/coulomb.H
index 08eb5c5..319f353 100644
--- a/src/lagrangian/molecularDynamics/potential/pairPotential/derived/coulomb/coulomb.H
+++ b/src/lagrangian/molecularDynamics/potential/pairPotential/derived/coulomb/coulomb.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::pairPotentials::electrostatic
+    Foam::pairPotentials::coulomb
 
 Description
 
diff --git a/src/lagrangian/molecularDynamics/potential/pairPotential/derived/dampedCoulomb/dampedCoulomb.H b/src/lagrangian/molecularDynamics/potential/pairPotential/derived/dampedCoulomb/dampedCoulomb.H
index a6e66c1..69b4671 100644
--- a/src/lagrangian/molecularDynamics/potential/pairPotential/derived/dampedCoulomb/dampedCoulomb.H
+++ b/src/lagrangian/molecularDynamics/potential/pairPotential/derived/dampedCoulomb/dampedCoulomb.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::pairPotentials::electrostatic
+    Foam::pairPotentials::dampedCoulomb
 
 Description
 
diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLineParticleCloud.H b/src/postProcessing/functionObjects/field/streamLine/streamLineParticleCloud.H
index 76b3f82..2eb4612 100644
--- a/src/postProcessing/functionObjects/field/streamLine/streamLineParticleCloud.H
+++ b/src/postProcessing/functionObjects/field/streamLine/streamLineParticleCloud.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::streamLineCloud
+    Foam::streamLineParticleCloud
 
 Description
     A Cloud of streamLine particles
diff --git a/src/thermophysicalModels/basic/rhoThermo/hRhoThermo/hRhoThermo.H b/src/thermophysicalModels/basic/rhoThermo/hRhoThermo/hRhoThermo.H
index d13ea01..bfdbd73 100644
--- a/src/thermophysicalModels/basic/rhoThermo/hRhoThermo/hRhoThermo.H
+++ b/src/thermophysicalModels/basic/rhoThermo/hRhoThermo/hRhoThermo.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::hPsiThermo
+    Foam::hRhoThermo
 
 Description
     Enthalpy for a mixture based on density
diff --git a/src/thermophysicalModels/chemistryModel/chemistrySolver/noChemistrySolver/noChemistrySolver.H b/src/thermophysicalModels/chemistryModel/chemistrySolver/noChemistrySolver/noChemistrySolver.H
index 752c8d6..de6bd0f 100644
--- a/src/thermophysicalModels/chemistryModel/chemistrySolver/noChemistrySolver/noChemistrySolver.H
+++ b/src/thermophysicalModels/chemistryModel/chemistrySolver/noChemistrySolver/noChemistrySolver.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::noChemistry
+    Foam::noChemistrySolver
 
 Description
     Dummy chemistry solver for 'none' option
diff --git a/src/thermophysicalModels/radiationModels/radiationModel/fvDOM/absorptionCoeffs/absorptionCoeffs.H b/src/thermophysicalModels/radiationModels/radiationModel/fvDOM/absorptionCoeffs/absorptionCoeffs.H
index f5279d5..1ef97d0 100644
--- a/src/thermophysicalModels/radiationModels/radiationModel/fvDOM/absorptionCoeffs/absorptionCoeffs.H
+++ b/src/thermophysicalModels/radiationModels/radiationModel/fvDOM/absorptionCoeffs/absorptionCoeffs.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::janafThermo
+    Foam::absorptionCoeffs
 
 Description
     Absorption coefficients class used in greyMeanAbsorptionEmission and
diff --git a/src/thermophysicalModels/radiationModels/submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionEmission.H b/src/thermophysicalModels/radiationModels/submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionEmission.H
index b301dee..2faf779 100644
--- a/src/thermophysicalModels/radiationModels/submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionEmission.H
+++ b/src/thermophysicalModels/radiationModels/submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionEmission.H
@@ -22,7 +22,7 @@ License
     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
 Class
-    Foam::radiation::greyMeanAbsorptionEmission
+    Foam::radiation::wideBandAbsorptionEmission
 
 Description
 
-- 
1.7.4.1

henry

2011-07-19 17:07

manager   ~0000572

Thanks for the bug-report and patch.
Resolved by commit 714ff6e85156caff69d09346ab741fc69da38403

user19

2011-07-20 10:43

  ~0000575

Ooops. I noticed that I was perhaps a bit overzealous, and modified some files containing partial template specialisations to refer to the base template instead of the "specialized" name.

- src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvSurfaceField.H
- src/finiteVolume/interpolation/mapping/fvFieldMappers/MapFvVolField.H

henry

2011-07-20 16:08

manager   ~0000577

Resolved by commit 0e846673e8571c02653987b69aa247e366bfcdfd

Issue History

Date Modified Username Field Change
2011-07-18 16:12 user19 New Issue
2011-07-18 16:12 user19 File Added: 0001-DOC-Fix-some-bogus-class-documentation-comments.patch
2011-07-19 17:07 henry Note Added: 0000572
2011-07-19 17:07 henry Status new => resolved
2011-07-19 17:07 henry Resolution open => fixed
2011-07-19 17:07 henry Assigned To => henry
2011-07-20 10:43 user19 Note Added: 0000575
2011-07-20 10:43 user19 Status resolved => feedback
2011-07-20 10:43 user19 Resolution fixed => reopened
2011-07-20 16:08 henry Note Added: 0000577
2011-07-20 16:08 henry Status feedback => resolved
2011-07-20 16:08 henry Resolution reopened => fixed