STYLE: change of doxygen tags for function objects and ico wall functions boundaryConditions

This commit is contained in:
andy
2012-07-12 10:35:09 +01:00
parent c448ba6505
commit 3dd7ab054b
48 changed files with 65 additions and 56 deletions

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup functionObjects Function objects \defgroup grpFunctionObjects Function objects
@{ @{
This group contains function objects This group contains function objects
@} @}

View File

@ -21,9 +21,9 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup IOFunctionObjects Input/outuput function objects \defgroup grpIOFunctionObjects Input/outuput function objects
@{ @{
\ingroup functionObjects \ingroup grpFunctionObjects
This group contains input/output-based function objects This group contains input/output-based function objects
@} @}

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup IOFunctionObjects \addtogroup grpIOFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup IOFunctionObjects \addtogroup grpIOFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup IOFunctionObjects \addtogroup grpIOFunctionObjects
@{ @{
Class Class

View File

@ -21,10 +21,13 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup cloudFunctionObjects Cloud function objects \defgroup grpCloudFunctionObjects Cloud function objects
@{ @{
\ingroup functionObjects \ingroup grpFunctionObjects
This group contains cloud-based function objects This group contains cloud-based function objects.
Function objects in this group are packaged into the
libcloudFunctionObjects.so library.
@} @}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup cloudFunctionObjects \addtogroup grpCloudFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
class class

View File

@ -21,10 +21,13 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup fieldFunctionObjects Field function objects \defgroup grpFieldFunctionObjects Field function objects
@{ @{
\ingroup functionObjects \ingroup grpFunctionObjects
This group contains field-based function objects This group contains field-based function objects
Function objects in this group are packaged into the
libfieldFunctionObjects.so library.
@} @}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup fieldFunctionObjects \addtogroup grpFieldFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup forcesFunctionObjects \addtogroup grpForcesFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup forcesFunctionObjects \addtogroup grpForcesFunctionObjects
@{ @{
Class Class

View File

@ -21,10 +21,13 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup forcesFunctionObjects Forces function objects \defgroup grpForcesFunctionObjects Forces function objects
@{ @{
\ingroup functionObjects \ingroup grpFunctionObjects
This group contains force-based function objects This group contains force-based function objects
Function objects in this group are packaged into the
libforcesFunctionObjects.so library.
@} @}
\*---------------------------------------------------------------------------*/ \*---------------------------------------------------------------------------*/

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup jobControlFunctionObjects \addtogroup grpJobControlFunctionObjects
@{ @{
Class Class

View File

@ -21,9 +21,9 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup jobControlFunctionObjects Job control function objects \defgroup grpJobControlFunctionObjects Job control function objects
@{ @{
\ingroup functionObjects \ingroup grpFunctionObjects
This group contains job control-based function objects This group contains job control-based function objects
@} @}

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup functionObjects \addtogroup grpFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup utilitiesFunctionObjects \addtogroup grpUtilitiesFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup utilitiesFunctionObjects \addtogroup grpUtilitiesFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup utilitiesFunctionObjects \addtogroup grpUtilitiesFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup utilitiesFunctionObjects \addtogroup grpUtilitiesFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup utilitiesFunctionObjects \addtogroup grpUtilitiesFunctionObjects
@{ @{
Class Class

View File

@ -21,9 +21,9 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup utilitiesFunctionObjects Utility function objects \defgroup grpUtilitiesFunctionObjects Utility function objects
@{ @{
\ingroup functionObjects \ingroup grpFunctionObjects
This group contains utility-based function objects This group contains utility-based function objects
@} @}

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup utilitiesFunctionObjects \addtogroup grpUtilitiesFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup utilitiesFunctionObjects \addtogroup grpUtilitiesFunctionObjects
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,9 +21,9 @@ License
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
OpenFOAM. If not, see <http://www.gnu.org/licenses/>. OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\defgroup icoWallFunctions RAS incompressible wall functions \defgroup grpIcoWallFunctions RAS incompressible wall functions
@{ @{
\ingroup boundaryConditions \ingroup grpBoundaryConditions
This group contains incompressible RAS turbulence model wall functions This group contains incompressible RAS turbulence model wall functions
@} @}

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class

View File

@ -21,7 +21,7 @@ License
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
\addtogroup icoWallFunctions \addtogroup grpIcoWallFunctions
@{ @{
Class Class