From da871b3bc575e4f676bcdde095635c81656e24ca Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Sun, 3 Jul 2016 23:17:54 +0100 Subject: [PATCH] functionObjects: Updated documentation Patch contributed by Bruno Santos Resolves bug-report http://bugs.openfoam.org/view.php?id=2138 --- .../removeRegisteredObject/removeRegisteredObject.H | 8 ++++---- src/functionObjects/utilities/writeObjects/writeObjects.H | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H index 42e36ba90..2fc5df303 100644 --- a/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H +++ b/src/functionObjects/utilities/removeRegisteredObject/removeRegisteredObject.H @@ -28,16 +28,16 @@ Group grpUtilitiesFunctionObjects Description - This function object removes registered objects if present in the database + Removes registered objects if present in the database. Example of function object specification: \verbatim removeRegisteredObject1 { type removeRegisteredObject; - libs ("libutilityFunctionObjects.so"); + libs ("libutilityFunctionObjects.so"); ... - objectNames (obj1 obj2); + objects (obj1 obj2); } \endverbatim @@ -45,7 +45,7 @@ Usage \table Property | Description | Required | Default value type | type name: removeRegisteredObject | yes | - objectNames | objects to remove | yes | + objects | objects to remove | yes | \endtable See also diff --git a/src/functionObjects/utilities/writeObjects/writeObjects.H b/src/functionObjects/utilities/writeObjects/writeObjects.H index 760951f1f..dbf395637 100644 --- a/src/functionObjects/utilities/writeObjects/writeObjects.H +++ b/src/functionObjects/utilities/writeObjects/writeObjects.H @@ -28,8 +28,8 @@ Group grpUtilitiesFunctionObjects Description - This function object allows specification of different writing frequency - of objects registered to the database. + Allows specification of different writing frequency of objects registered to + the database. It has similar functionality as the main time database through the writeControl setting: @@ -48,7 +48,7 @@ Description libs ("libutilityFunctionObjects.so"); exclusiveWriting true; ... - objectNames (obj1 obj2); + objects (obj1 obj2); } \endverbatim @@ -56,7 +56,7 @@ Usage \table Property | Description | Required | Default value type | type name: writeObjects | yes | - objectNames | objects to write | yes | + objects | objects to write | yes | exclusiveWriting | Takes over object writing | no | yes \endtable