Rationalized Doxygen documentation of command-line options

2016-06-17 09:11:58 +01:00
parent 0b333a4249
commit 7b75d81269
28 changed files with 389 additions and 360 deletions
--- a/applications/utilities/surface/surfaceConvert/surfaceConvert.C
+++ b/applications/utilities/surface/surfaceConvert/surfaceConvert.C
@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@ -28,16 +28,17 @@ Description
    Converts from one surface mesh format to another.

 Usage
-    - surfaceConvert inputFile outputFile [OPTION]
+    \b surfaceConvert inputFile outputFile [OPTION]

-    \param -clean \n
-    Perform some surface checking/cleanup on the input surface
+    Options:
+      - \par -clean
+        Perform some surface checking/cleanup on the input surface

-    \param -scale \<scale\> \n
-    Specify a scaling factor for writing the files
+      - \par -scale \<scale\>
+        Specify a scaling factor for writing the files

-    \param -group \n
-    Orders faces by region
+      - \par -group
+        Orders faces by region

 Note
    The filename extensions are used to determine the file format type.
--- a/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
+++ b/applications/utilities/surface/surfaceMeshConvert/surfaceMeshConvert.C
@ -29,28 +29,29 @@ Description
    transformations (rotate/translate) on a coordinateSystem.

 Usage
-    - surfaceMeshConvert inputFile outputFile [OPTION]
+    \b surfaceMeshConvert inputFile outputFile [OPTION]

-    \param -clean \n
-    Perform some surface checking/cleanup on the input surface.
+    Options:
+      - \par -clean
+        Perform some surface checking/cleanup on the input surface.

-    \param -scaleIn \<scale\> \n
-    Specify a scaling factor when reading files.
+      - \par -scaleIn \<scale\>
+        Specify a scaling factor when reading files.

-    \param -scaleOut \<scale\> \n
-    Specify a scaling factor when writing files.
+      - \par -scaleOut \<scale\>
+        Specify a scaling factor when writing files.

-    \param -dict \<dictionary\> \n
-    Specify an alternative dictionary for constant/coordinateSystems.
+      - \par -dict \<dictionary\>
+        Specify an alternative dictionary for constant/coordinateSystems.

-    \param -from \<coordinateSystem\> \n
-    Specify a coordinate System when reading files.
+      - \par -from \<coordinateSystem\>
+        Specify a coordinate System when reading files.

-    \param -to \<coordinateSystem\> \n
-    Specify a coordinate System when writing files.
+      - \par -to \<coordinateSystem\>
+        Specify a coordinate System when writing files.

-    \param -tri \n
-    Triangulate surface.
+      - \par -tri
+        Triangulate surface.

 Note
    The filename extensions are used to determine the file format type.
--- a/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
+++ b/applications/utilities/surface/surfaceMeshConvertTesting/surfaceMeshConvertTesting.C
@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@ -29,22 +29,23 @@ Description
    used for testing functionality.

 Usage
-    - surfaceMeshConvertTesting inputFile outputFile [OPTION]
+    \b surfaceMeshConvertTesting inputFile outputFile [OPTION]

-    \param -clean \n
-    Perform some surface checking/cleanup on the input surface
+    Options:
+      - \par -clean
+        Perform some surface checking/cleanup on the input surface

-    \param -orient \n
-    Check face orientation on the input surface
+      - \par -orient
+        Check face orientation on the input surface

-    \param -scale \<scale\> \n
-    Specify a scaling factor for writing the files
+      - \par -scale \<scale\>
+        Specify a scaling factor for writing the files

-    \param -triSurface \n
-    Use triSurface library for input/output
+      - \par -triSurface
+        Use triSurface library for input/output

-    \param -keyed \n
-    Use keyedSurface for input/output
+      - \par -keyed
+        Use keyedSurface for input/output

 Note
    The filename extensions are used to determine the file format type.
--- a/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
+++ b/applications/utilities/surface/surfaceMeshExport/surfaceMeshExport.C
@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@ -30,28 +30,29 @@ Description
    coordinateSystem.

 Usage
-    - surfaceMeshExport outputFile [OPTION]
+    \b surfaceMeshExport outputFile [OPTION]

-    \param -clean \n
-    Perform some surface checking/cleanup on the input surface.
+    Options:
+      - \par -clean
+        Perform some surface checking/cleanup on the input surface.

-    \param -name \<name\> \n
-    Specify an alternative surface name when writing.
+      - \par -name \<name\>
+        Specify an alternative surface name when writing.

-    \param -scaleIn \<scale\> \n
-    Specify a scaling factor when reading files.
+      - \par -scaleIn \<scale\>
+        Specify a scaling factor when reading files.

-    \param -scaleOut \<scale\> \n
-    Specify a scaling factor when writing files.
+      - \par -scaleOut \<scale\>
+        Specify a scaling factor when writing files.

-    \param -dict \<dictionary\> \n
-    Specify an alternative dictionary for constant/coordinateSystems.
+      - \par -dict \<dictionary\>
+        Specify an alternative dictionary for constant/coordinateSystems.

-    \param -from \<coordinateSystem\> \n
-    Specify a coordinate system when reading files.
+      - \par -from \<coordinateSystem\>
+        Specify a coordinate system when reading files.

-    \param -to \<coordinateSystem\> \n
-    Specify a coordinate system when writing files.
+      - \par -to \<coordinateSystem\>
+        Specify a coordinate system when writing files.

 Note
    The filename extensions are used to determine the file format type.
--- a/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
+++ b/applications/utilities/surface/surfaceMeshImport/surfaceMeshImport.C
@ -2,7 +2,7 @@
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2011-2015 OpenFOAM Foundation
+    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
     \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@ -30,28 +30,29 @@ Description
    on a coordinateSystem.

 Usage
-    - surfaceMeshImport inputFile [OPTION]
+    \b surfaceMeshImport inputFile [OPTION]

-    \param -clean \n
-    Perform some surface checking/cleanup on the input surface.
+    Options:
+      - \par -clean \n
+        Perform some surface checking/cleanup on the input surface.

-    \param -name \<name\> \n
-    Specify an alternative surface name when writing.
+      - \par -name \<name\> \n
+        Specify an alternative surface name when writing.

-    \param -scaleIn \<scale\> \n
-    Specify a scaling factor when reading files.
+      - \par -scaleIn \<scale\> \n
+        Specify a scaling factor when reading files.

-    \param -scaleOut \<scale\> \n
-    Specify a scaling factor when writing files.
+      - \par -scaleOut \<scale\> \n
+        Specify a scaling factor when writing files.

-    \param -dict \<dictionary\> \n
-    Specify an alternative dictionary for constant/coordinateSystems.
+      - \par -dict \<dictionary\> \n
+        Specify an alternative dictionary for constant/coordinateSystems.

-    \param -from \<coordinateSystem\> \n
-    Specify a coordinate system when reading files.
+      - \par -from \<coordinateSystem\> \n
+        Specify a coordinate system when reading files.

-    \param -to \<coordinateSystem\> \n
-    Specify a coordinate system when writing files.
+      - \par -to \<coordinateSystem\> \n
+        Specify a coordinate system when writing files.

 Note
    The filename extensions are used to determine the file format type.
--- a/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
+++ b/applications/utilities/surface/surfaceMeshInfo/surfaceMeshInfo.C
@ -28,16 +28,17 @@ Description
    Miscellaneous information about surface meshes.

 Usage
-    - surfaceMeshInfo surfaceFile [OPTION]
+    \b surfaceMeshInfo surfaceFile [OPTION]

-    \param -areas \n
-    Report area for each face.
+    Options:
+      - \par -areas
+        Report area for each face.

-    \param -scale \<scale\> \n
-    Specify a scaling factor when reading files.
+      - \par -scale \<scale\>
+        Specify a scaling factor when reading files.

-    \param -xml \n
-    Write output in XML format.
+      - \par -xml
+        Write output in XML format.

 Note
    The filename extensions are used to determine the file format type.