ENH: Updates to function object documentation

This commit is contained in:
andy
2012-07-23 15:23:35 +01:00
parent e6a41726e2
commit a17b0c75c6
30 changed files with 74 additions and 42 deletions

View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup functionObjects
@{
Class
Foam::probes
Group
grpFunctionObjects
Description
Set of locations to sample.
@ -34,7 +34,6 @@ Description
SourceFiles
probes.C
@}
\*---------------------------------------------------------------------------*/

View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup functionObjects
@{
Class
Foam::sampledSet
Group
grpFunctionObjects
Description
Holds list of sampling points which is filled at construction time.
Various implementations of this base class to e.g. get sampling points
@ -38,7 +38,6 @@ Description
SourceFiles
sampledSet.C
@}
\*---------------------------------------------------------------------------*/

View File

@ -21,12 +21,12 @@ License
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup functionObjects
@{
Class
Foam::sampledSurface
Group
grpFunctionObjects
Description
An abstract class for surfaces with sampling.
@ -46,7 +46,6 @@ Description
SourceFiles
sampledSurface.C
sampledSurfaceTemplates.C
@}
\*---------------------------------------------------------------------------*/