Commit e8171d01 authored by Andrew Heather's avatar Andrew Heather
Browse files

STYLE: Updated header documentation

parent 73023144
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::RosinRammler
Foam::distributionModels::RosinRammler
Description
Rosin-Rammler distributionModel
......@@ -39,8 +39,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/
#ifndef RosinRammler_H
#define RosinRammler_H
#ifndef distributionModels_RosinRammler_H
#define distributionModels_RosinRammler_H
#include "distributionModel.H"
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::exponential
Foam::distributionModels::exponential
Description
exponential distribution model
......@@ -32,8 +32,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/
#ifndef exponential_H
#define exponential_H
#ifndef distributionModels_exponential_H
#define distributionModels_exponential_H
#include "distributionModel.H"
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::fixedValue
Foam::distributionModels::fixedValue
Description
Returns a fixed value
......@@ -32,8 +32,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/
#ifndef distributionModelFixedValue_H
#define distributionModelFixedValue_H
#ifndef distributionModels_fixedValue_H
#define distributionModels_fixedValue_H
#include "distributionModel.H"
......@@ -44,7 +44,7 @@ namespace Foam
namespace distributionModels
{
/*---------------------------------------------------------------------------*\
Class fixedValue Declaration
Class fixedValue Declaration
\*---------------------------------------------------------------------------*/
class fixedValue
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::general
Foam::distributionModels::general
Description
general distribution model
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::multiNormal
Foam::distributionModels::multiNormal
Description
A multiNormal distribution model
......@@ -37,8 +37,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/
#ifndef multiNormal_H
#define multiNormal_H
#ifndef distributionModels_multiNormal_H
#define distributionModels_multiNormal_H
#include "distributionModel.H"
......@@ -50,7 +50,7 @@ namespace distributionModels
{
/*---------------------------------------------------------------------------*\
Class multiNormal Declaration
Class multiNormal Declaration
\*---------------------------------------------------------------------------*/
class multiNormal
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::normal
Foam::distributionModels::normal
Description
A normal distribution model
......@@ -38,8 +38,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/
#ifndef normal_H
#define normal_H
#ifndef distributionModels_normal_H
#define distributionModels_normal_H
#include "distributionModel.H"
......
......@@ -22,7 +22,7 @@ License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::uniform
Foam::distributionModels::uniform
Description
Uniform/equally-weighted distribution model
......@@ -32,8 +32,8 @@ SourceFiles
\*---------------------------------------------------------------------------*/
#ifndef uniform_H
#define uniform_H
#ifndef distributionModels_uniform_H
#define distributionModels_uniform_H
#include "distributionModel.H"
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment