Commit 1b45fab9 authored by Mark Olesen's avatar Mark Olesen
Browse files

Add minor documentation to pTraits specializations.

parent 2df9e0c3
......@@ -60,7 +60,7 @@ word name(const Scalar val)
Scalar readScalar(Istream& is)
{
Scalar rs;
is >> rs;
is >> rs;
return rs;
}
......
......@@ -50,9 +50,9 @@ public:
enum
{
dim = 3, // Dimensionality of space
rank = 0, // Rank of Scalar is 0
nComponents = 1 // Number of components in Scalar is 1
dim = 3, //!< Dimensionality of space
rank = 0, //!< Rank of Scalar is 0
nComponents = 1 //!< Number of components in Scalar is 1
};
// Static data members
......@@ -72,6 +72,7 @@ public:
// Member Functions
//- Conversion to a Scalar
operator Scalar() const
{
return p_;
......
......@@ -86,8 +86,8 @@ public:
enum
{
dim = 3, // Dimensionality of space
nComponents = nCmpt // Number of components in this vector space
dim = 3, //!< Dimensionality of space
nComponents = nCmpt //!< Number of components in this vector space
};
......
......@@ -76,9 +76,9 @@ public:
enum
{
dim = 3, // Dimensionality of space
rank = 0, // Rank of bool is 0
nComponents = 1 // Number of components in bool is 1
dim = 3, //!< Dimensionality of space
rank = 0, //!< Rank of bool is 0
nComponents = 1 //!< Number of components in bool is 1
};
// Static data members
......@@ -95,6 +95,7 @@ public:
// Member Functions
//- Conversion to a bool
operator bool() const
{
return p_;
......
......@@ -148,9 +148,9 @@ public:
enum
{
dim = 3, // Dimensionality of space
rank = 0, // Rank of label is 0
nComponents = 1 // Number of components in label is 1
dim = 3, //!< Dimensionality of space
rank = 0, //!< Rank of label is 0
nComponents = 1 //!< Number of components in label is 1
};
// Static data members
......@@ -169,6 +169,7 @@ public:
// Member Functions
//- Conversion to a label
operator label() const
{
return p_;
......
......@@ -132,9 +132,9 @@ public:
enum
{
dim = 3, // Dimensionality of space
rank = 0, // Rank of uLabel is 0
nComponents = 1 // Number of components in uLabel is 1
dim = 3, //!< Dimensionality of space
rank = 0, //!< Rank of uLabel is 0
nComponents = 1 //!< Number of components in uLabel is 1
};
// Static data members
......@@ -154,6 +154,7 @@ public:
// Member Functions
//- Conversion to a uLabel
operator uLabel() const
{
return p_;
......
Markdown is supported
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