Merge branch 'master' of /home/noisy3/OpenFOAM/OpenFOAM-dev

doc/doxygen/Doxyfile

@@ -207,14 +207,16 @@ OPTIMIZE_FOR_FORTRAN   = NO
 
 OPTIMIZE_OUTPUT_VHDL   = NO
 
-# Doxygen selects the parser to use depending on the extension of the files it parses.
+# Doxygen selects the parser to use depending on the extension of the files it
-# With this tag you can assign which parser to use for a given extension.
+# parses.  With this tag you can assign which parser to use for a given
-# Doxygen has a built-in mapping, but you can override or extend it using this tag.
+# extension.  Doxygen has a built-in mapping, but you can override or extend it
-# The format is ext=language, where ext is a file extension, and language is one of
+# using this tag.  The format is ext=language, where ext is a file extension,
-# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
+# and language is one of the parsers supported by doxygen: IDL, Java,
-# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
+# Javascript, C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
-# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
+# C++. For instance to make doxygen treat .inc files as Fortran files (default
-# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
+# that for custom extensions you also need to set FILE_PATTERNS otherwise the
+# files are not read by doxygen.
 
 EXTENSION_MAPPING      =
 
@@ -238,10 +240,10 @@ CPP_CLI_SUPPORT        = NO
 
 SIP_SUPPORT            = NO
 
-# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# For Microsoft's IDL there are propget and propput attributes to indicate
-# and setter methods for a property. Setting this option to YES (the default)
+# getter and setter methods for a property. Setting this option to YES (the
-# will make doxygen to replace the get and set methods by a property in the
+# default) will make doxygen to replace the get and set methods by a property in
-# documentation. This will only work if the methods are indeed getting or
+# the documentation. This will only work if the methods are indeed getting or
 # setting a simple type. If this is not the case, or you want to show the
 # methods anyway, you should set this option to NO.
 
@@ -411,7 +413,12 @@ SORT_MEMBER_DOCS       = NO
 
 SORT_BRIEF_DOCS        = NO
 
-# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO (the default) the constructors will
+# appear in the respective orders defined by SORT_MEMBER_DOCS and
+# SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is
+# set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
 
 SORT_MEMBERS_CTORS_1ST = NO
 
@@ -505,12 +512,12 @@ SHOW_NAMESPACES        = YES
 
 FILE_VERSION_FILTER    =
 
-# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
-# doxygen. The layout file controls the global structure of the generated output files
+# by doxygen. The layout file controls the global structure of the generated
-# in an output format independent way. The create the layout file that represents
+# output files in an output format independent way. The create the layout file
-# doxygen's defaults, run doxygen with the -l option. You can optionally specify a
+# that represents doxygen's defaults, run doxygen with the -l option. You can
-# file name after the option, if omitted DoxygenLayout.xml will be used as the name
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
-# of the layout file.
+# will be used as the name of the layout file.
 
 LAYOUT_FILE            =
 
@@ -582,6 +589,7 @@ WARN_LOGFILE           =
 INPUT                  = $(WM_PROJECT_DIR)/src/OpenFOAM/global \
                          $(WM_PROJECT_DIR)/src/OpenFOAM/containers \
                          $(WM_PROJECT_DIR)/src/OpenFOAM/primitives \
+                         $(WM_PROJECT_DIR)/sampling \
                          $(WM_PROJECT_DIR)/src/finiteVolume/fvMesh
 
 # This tag can be used to specify the character encoding of the source files
@@ -837,15 +845,15 @@ HTML_ALIGN_MEMBERS     = YES
 
 HTML_DYNAMIC_SECTIONS  = NO
 
-# If the GENERATE_DOCSET tag is set to YES, additional index files
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
-# will be generated that can be used as input for Apple's Xcode 3
+# generated that can be used as input for Apple's Xcode 3 integrated development
-# integrated development environment, introduced with OSX 10.5 (Leopard).
+# environment, introduced with OSX 10.5 (Leopard).  To create a documentation
-# To create a documentation set, doxygen will generate a Makefile in the
+# set, doxygen will generate a Makefile in the HTML output directory. Running
-# HTML output directory. Running make will produce the docset in that
+# make will produce the docset in that directory and running "make install" will
-# directory and running "make install" will install the docset in
+# install the docset in ~/Library/Developer/Shared/Documentation/DocSets so that
-# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# Xcode will find it at startup.  See
-# it at startup.
+# http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more
-# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
+# information.
 
 GENERATE_DOCSET        = NO
 
@@ -907,10 +915,10 @@ BINARY_TOC             = NO
 
 TOC_EXPAND             = NO
 
-# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
-# are set, an additional index file will be generated that can be used as input for
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
-# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
-# HTML documentation.
+# (.qch) of the generated HTML documentation.
 
 GENERATE_QHP           = NO
 
@@ -932,20 +940,23 @@ QHP_NAMESPACE          = org.doxygen.Project
 
 QHP_VIRTUAL_FOLDER     = doc
 
-# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
-# For more information please see
+# add.  For more information please see
 # http://doc.trolltech.com/qthelpproject.html#custom-filters
 
 QHP_CUST_FILTER_NAME   =
 
-# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom
-# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
+# filter to add.For more information please see <a
+# href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help
+# Project / Custom Filters</a>.
 
 QHP_CUST_FILTER_ATTRS  =
 
-# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
-# filter section matches.
+# project's filter section matches.  <a
-# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
+# href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help
+# Project / Filter Attributes</a>.
 
 QHP_SECT_FILTER_ATTRS  =
 
@@ -956,13 +967,14 @@ QHP_SECT_FILTER_ATTRS  =
 
 QHG_LOCATION           =
 
-# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
-#  will be generated, which together with the HTML files, form an Eclipse help
+#  generated, which together with the HTML files, form an Eclipse help
 #  plugin. To install this plugin and make it available under the help contents
 #  menu in Eclipse, the contents of the directory containing the HTML and XML
 #  files needs to be copied into the plugins directory of eclipse. The name of
-# the directory within the plugins directory should be the same as
+#  the directory within the plugins directory should be the same as the
-# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears.
+#  ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the
+#  help appears.
 
 GENERATE_ECLIPSEHELP   = NO
 
@@ -1012,16 +1024,23 @@ TREEVIEW_WIDTH         = 250
 
 FORMULA_FONTSIZE       = 10
 
-# When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
-# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should
+# the HTML output. The underlying search engine uses javascript and DHTML and
-# typically be disabled. For large projects the javascript based search engine
+# should work on any modern browser. Note that when using HTML help
-# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be
+# disabled. For large projects the javascript based search engine can be slow,
+# then enabling SERVER_BASED_SEARCH may provide a better solution.
 
 SEARCHENGINE           = YES
 
-# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
-# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup
+# implemented using a PHP enabled web server instead of at the web client using
-# and does not have live searching capabilities.
+# Javascript. Doxygen will generate the search PHP script and index file to put
+# on the web server. The advantage of the server based approach is that it
+# scales better to large projects and allows full text search. The disadvances
+# is that it is more difficult to setup and does not have live searching
+# capabilities.
 
 SERVER_BASED_SEARCH    = NO
 # old default
@@ -1106,7 +1125,9 @@ LATEX_BATCHMODE        = NO
 
 LATEX_HIDE_INDICES     = NO
 
-# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with
+# syntax highlighting in the LaTeX output. Note that which sources are shown
+# also depends on other settings such as SOURCE_BROWSER.
 
 LATEX_SOURCE_CODE      = NO
 
@@ -1409,8 +1430,8 @@ HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = YES
 
 # By default doxygen will write a font called FreeSans.ttf to the output
-# directory and reference it in all dot files that doxygen generates. This
+# directory and reference it in all dot files that doxygen generates. This font
-# font does not include all possible unicode characters however, so when you need
+# does not include all possible unicode characters however, so when you need
 # these (or just want a differently looking font) you can specify the font name
 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
 # which can be done by putting it in a standard location or by setting the

src/OpenFOAM/include/OSspecific.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -90,7 +90,8 @@ fileName cwd();
 //  else return false
 bool chDir(const fileName& dir);
 
-//- Search for @em name in the following hierarchy:
+//- Search for @em name
+//  in the following hierarchy:
 //  -# personal settings:
 //    - ~/.OpenFOAM/\<VERSION\>/
 //      <em>for version-specific files</em>

src/OpenFOAM/meshes/meshShapes/edge/edge.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -122,6 +122,7 @@ public:
         inline linePointRef line(const pointField&) const;
 
         //- compare edges
+        //  Returns:
         //  -  0: different
         //  - +1: identical
         //  - -1: same edge, but different orientation

src/OpenFOAM/meshes/meshShapes/face/face.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -307,6 +307,7 @@ public:
         inline edge faceEdge(const label n) const;
 
         //- Return the edge direction on the face
+        //  Returns:
         //  -  0: edge not found on the face
         //  - +1: forward (counter-clockwise) on the face
         //  - -1: reverse (clockwise) on the face

src/OpenFOAM/meshes/meshShapes/triFace/triFace.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -201,12 +201,14 @@ public:
         inline edge faceEdge(const label n) const;
 
         //- Return the edge direction on the face
+        //  Returns:
         //  - +1: forward (counter-clockwise) on the face
         //  - -1: reverse (clockwise) on the face
         //  -  0: edge not found on the face
         inline int edgeDirection(const edge&) const;
 
         //- compare triFaces
+        //  Returns:
         //  -  0: different
         //  - +1: identical
         //  - -1: same face, but different orientation

src/OpenFOAM/meshes/polyMesh/globalMeshData/globalMeshData.H

@@ -509,7 +509,8 @@ public:
 
             // Other
 
-                //- Helper for merging mesh point data. Determines
+                //- Helper for merging mesh point data.
+                //  Determines:
                 //  - my unique indices
                 //  - global numbering over all unique indices
                 //  - the global number for all local points (so this will
@@ -520,7 +521,8 @@ public:
                     labelList& uniquePoints
                 ) const;
 
-                //- Helper for merging patch point data. Takes maps from
+                //- Helper for merging patch point data.
+                //  Takes maps from:
                 //  local points to/from mesh. Determines
                 //  - my unique points. These are mesh points, not patch points
                 //    since the master might not be on the patch.

src/OpenFOAM/meshes/primitiveMesh/PrimitivePatch/PrimitivePatch.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -415,6 +415,7 @@ public:
     // Check
 
         //- Calculate surface type formed by patch.
+        //  Types:
         //  - all edges have two neighbours (manifold)
         //  - some edges have more than two neighbours (illegal)
         //  - other (open)

src/OpenFOAM/primitives/Pair/Pair.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -134,7 +134,8 @@ public:
         }
 
 
-        //- compare Pairs
+        //- Compare Pairs
+        //  Returning:
         //  -  0: different
         //  - +1: identical
         //  - -1: same pair, but reversed order

src/OpenFOAM/primitives/globalIndexAndTransform/globalIndexAndTransform.H

@@ -65,9 +65,10 @@ public:
     // Public classes
 
         //- Less function class used in sorting encoded transforms and indices
-        //  - minimum processor
+        //  Minimum of:
-        //  - minimum local index
+        //  - processor
-        //  - minimum transform
+        //  - local index
+        //  - transform
         class less
         {
         public:

src/dynamicMesh/polyMeshAdder/polyMeshAdder.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -281,7 +281,8 @@ public:
 
         // Point merging
 
-            //- Find topologically&geometrically shared points.
+            //- Find topologically and geometrically shared points.
+            //
             //  - should only be called for parallel correct mesh
             //    (since uses mesh.globalData)
             //  - returns Map from point to master point (all in mesh point
@@ -293,6 +294,7 @@ public:
             );
 
             //- Helper: Merge points.
+            //
             //  - Gets map from point to destination point
             //  - Removes all points that don't map to themselves
             //  - Modifies all faces that use the points to be removed.

src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -382,6 +382,7 @@ public:
             ) const;
 
             //- Like consistentRefinement but slower:
+            //
             //  - specify number of cells between consecutive refinement levels
             //    (consistentRefinement equivalent to 1)
             //  - specify max level difference between point-connected cells.

src/dynamicMesh/polyTopoChange/polyTopoChange/removeCells.C

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -36,14 +36,11 @@ License
 
 namespace Foam
 {
-
     defineTypeNameAndDebug(removeCells, 0);
-
 }
 
 // * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //
 
-// Remove count of elements of f.
 void Foam::removeCells::uncount
 (
     const labelList& f,
@@ -59,7 +56,6 @@ void Foam::removeCells::uncount
 
 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
-// Construct from mesh
 Foam::removeCells::removeCells
 (
     const polyMesh& mesh,
@@ -73,10 +69,6 @@ Foam::removeCells::removeCells
 
 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
 
-//- Get labels of exposed faces. These are
-//  - internal faces that become boundary faces
-//  - coupled faces that become uncoupled (since on of the sides
-//    gets deleted)
 Foam::labelList Foam::removeCells::getExposedFaces
 (
     const labelList& cellLabels

src/dynamicMesh/polyTopoChange/polyTopoChange/removeCells.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -94,7 +94,8 @@ public:
 
         // Topology changes
 
-            //- Get labels of exposed faces. These are
+            //- Get labels of exposed faces.
+            //  These are
             //  - internal faces that become boundary faces
             //  - coupled faces that become uncoupled (since one of the sides
             //    gets deleted)
@@ -114,7 +115,6 @@ public:
             //- Force recalculation of locally stored data on topological change
             void updateMesh(const mapPolyMesh&)
             {}
-
 };
 
 

src/dynamicMesh/polyTopoChange/polyTopoChange/removeFaces.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -178,7 +178,8 @@ public:
 
     // Member Functions
 
-        //- Given set of faces to pierce calculates:
+        //- Find faces including those with cells which have the same mastercell
+        //  Given set of faces to pierce calculates:
         //  - region for connected cells
         //  - mastercell for each region. This is the lowest numbered cell
         //    of all cells that get merged.

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H

@@ -26,7 +26,6 @@ Class
 
 Description
     Multi-point cone injection model
-
     - User specifies
       - time of start of injection
       - list of injector positions and directions (along injection axes)

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H

@@ -26,7 +26,6 @@ Class
 
 Description
     Manual injection
-
     - User specifies
       - Total mass to inject
       - Parcel positions in file @c positionsFile

src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H

@@ -26,7 +26,6 @@ Class
 
 Description
     Patch injection
-
     - User specifies
       - Total mass to inject
       - Name of patch

src/mesh/blockMesh/curvedEdges/curvedEdge.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -130,18 +130,21 @@ public:
         inline label end() const;
 
         //- Compare the given start and end points with this curve
+        //  Return:
         //  -  0: different
         //  - +1: identical
         //  - -1: same edge, but different orientation
         inline int compare(const curvedEdge&) const;
 
         //- Compare the given start and end points with this curve
+        //  Return:
         //  -  0: different
         //  - +1: identical
         //  - -1: same edge, but different orientation
         inline int compare(const edge&) const;
 
         //- Compare the given start and end points with this curve
+        //  Return:
         //  -  0: different
         //  - +1: identical
         //  - -1: same edge, but different orientation
@@ -159,6 +162,7 @@ public:
 
         void operator=(const curvedEdge&);
 
+
     // Ostream operator
 
         friend Ostream& operator<<(Ostream&, const curvedEdge&);

src/meshTools/directMapped/directMappedPolyPatch/directMappedPatchBase.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -107,6 +107,7 @@ public:
 
 
     //- Helper class for finding nearest
+    // Nearest:
     //  - point+local index
     //  - sqr(distance)
     //  - processor

src/meshTools/indexedOctree/indexedOctree.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -511,7 +511,8 @@ public:
 
         // Queries
 
-            //- Calculate nearest point on nearest shape. Returns
+            //- Calculate nearest point on nearest shape.
+            //  Returns
             //  - bool : any point found nearer than nearestDistSqr
             //  - label: index in shapes
             //  - point: actual nearest point found
@@ -532,7 +533,8 @@ public:
                 point& nearestPoint
             ) const;
 
-            //- Find nearest to line. Returns
+            //- Find nearest to line.
+            //  Returns
             //  - bool : any point found?
             //  - label: index in shapes
             //  - point: actual nearest point found
@@ -621,10 +623,10 @@ public:
 
             bool write(Ostream& os) const;
 
+
     // IOstream Operators
 
         friend Ostream& operator<< <Type>(Ostream&, const indexedOctree<Type>&);
-
 };
 
 

src/meshTools/meshSearch/meshSearch.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -195,6 +195,7 @@ public:
             bool pointInCell(const point& p, const label celli) const;
 
             //- Find nearest cell in terms of cell centre.
+            //  Options:
             //  - use octree
             //  - use linear search
             //  - if seed is provided walk. (uses findNearestCellWalk;

src/meshTools/searchableSurface/searchableBox.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -131,7 +131,8 @@ public:
 
         // Single point queries.
 
-            //- Calculate nearest point on surface. Returns
+            //- Calculate nearest point on surface.
+            //  Returns
             //  - bool : any point found nearer than nearestDistSqr
             //  - label: relevant index in surface (=face 0..5)
             //  - point: actual nearest point found
@@ -141,7 +142,8 @@ public:
                 const scalar nearestDistSqr
             ) const;
 
-            //- Calculate nearest point on edge. Returns
+            //- Calculate nearest point on edge.
+            //  Returns
             //  - bool : any point found nearer than nearestDistSqr
             //  - label: relevant index in surface(=?)
             //  - point: actual nearest point found
@@ -151,7 +153,8 @@ public:
                 const scalar nearestDistSqr
             ) const;
 
-            //- Find nearest to segment. Returns
+            //- Find nearest to segment.
+            //  Returns
             //  - bool : any point found?
             //  - label: relevant index in shapes (=face 0..5)
             //  - point: actual nearest point found
@@ -241,7 +244,6 @@ public:
                 notImplemented("searchableBox::writeData(Ostream&) const");
                 return false;
             }
-
 };
 
 

src/meshTools/triSurface/surfaceLocation/surfaceLocation.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -26,7 +26,6 @@ Class
 
 Description
     Contains information about location on a triSurface:
-
     - pointIndexHit:
         - location
         - bool: hit/miss

src/meshTools/triSurface/triSurfaceTools/triSurfaceTools.H

@@ -2,7 +2,7 @@
   =========                 |
   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
    \\    /   O peration     |
-    \\  /    A nd           | Copyright (C) 2004-2010 OpenCFD Ltd.
+    \\  /    A nd           | Copyright (C) 2004-2011 OpenCFD Ltd.
      \\/     M anipulation  |
 -------------------------------------------------------------------------------
 License
@@ -518,8 +518,7 @@ public:
 
     // Tracking
 
-        //- Test point on plane of triangle to see if on edge or point
+        //- Test point on plane of triangle to see if on edge or point or inside
-        //  or inside.
         static surfaceLocation classify
         (
             const triSurface&,
@@ -527,7 +526,8 @@ public:
             const point& trianglePoint
         );
 
-        //- Track on surface to get closer to point. Possible situations:
+        //- Track on surface to get closer to point.
+        //  Possible situations:
         //  - 1. reached endpoint
         //  - 2. reached edge (normal situation)
         //  - 3. reached end of surface (edge on single face)

src/sampling/sampledSurface/sampledTriSurfaceMesh/sampledTriSurfaceMesh.C

@@ -56,6 +56,7 @@ namespace Foam
 
 
     //- Private class for finding nearest
+    //  Comprising:
     //  - global index
     //  - sqr(distance)
     typedef Tuple2<scalar, label> nearInfo;