diff --git a/README.org b/README.org index 58df48f05..580ce67d3 100644 --- a/README.org +++ b/README.org @@ -1,9 +1,9 @@ # -*- mode: org; -*- # -#+TITLE: README for [[http://www.openfoam.org/dev.php][OpenFOAM-dev]] +#+TITLE: README for [[http://openfoam.org/download/source][OpenFOAM-dev]] #+AUTHOR: The OpenFOAM Foundation -#+DATE: 20th April 2016 -#+LINK: http://www.openfoam.org +#+DATE: 20th June 2016 +#+LINK: http://openfoam.org #+OPTIONS: author:nil ^:{} # Copyright (c) 2015-2016 OpenFOAM Foundation. @@ -23,9 +23,9 @@ [[http://www.gnu.org/licenses/]], for a description of the GNU General Public License terms under which you can copy the files. -* [[http://www.OpenFOAM.org/git.php][Download and installation instructions]] -* [[http://www.OpenFOAM.org/docs][Documentation]] +* [[http://OpenFOAM.org/download/source][Download and installation instructions]] +* [[http://OpenFOAM.org/docs][Documentation]] * [[http://OpenFOAM.github.io/Documentation-dev/html][Source code documentation]] * [[http://OpenFOAM.github.io/Documentation-dev/html/codingStyleGuide.html][OpenFOAM C++ Style Guide]] -* [[http://www.OpenFOAM.org/bugs][Reporting bugs in OpenFOAM]] -* [[http://www.openfoam.org/contact][Contacting the OpenFOAM Foundation]] +* [[http://OpenFOAM.org/bugs][Reporting bugs in OpenFOAM]] +* [[http://openfoam.org/contact][Contacting the OpenFOAM Foundation]] diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C index 7c6fb584f..c620bea28 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/DelaunayMesh/DistributedDelaunayMesh.C @@ -957,7 +957,7 @@ Foam::DistributedDelaunayMesh::rangeInsertReferredWithInfo } else if (lt == Triangulation::OUTSIDE_CONVEX_HULL) { - // @todo Can this be optimised? + // TODO: Can this be optimised? // // Only want to insert if a connection is formed between // pointToInsert and an internal or internal boundary point. diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C index b0ef8a48b..88c31a0f7 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.C @@ -1434,7 +1434,7 @@ Foam::labelList Foam::backgroundMeshDecomposition::overlapProcessors //// map().distribute(testCentres); //// map().distribute(testRadiusSqrs); // -// // @todo This is faster, but results in more vertices being referred +// // TODO: This is faster, but results in more vertices being referred // boolList sphereOverlapsCandidate(testCentres.size(), true); //// boolList sphereOverlapsCandidate(testCentres.size(), false); //// @@ -1551,7 +1551,7 @@ Foam::labelList Foam::backgroundMeshDecomposition::overlapProcessors // map().distribute(testCentres); // map().distribute(testRadiusSqrs); // -// // @todo This is faster, but results in more vertices being referred +// // TODO: This is faster, but results in more vertices being referred //// boolList sphereOverlapsCandidate(testCentres.size(), true); // boolList sphereOverlapsCandidate(testCentres.size(), false); // diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C index 8c597b90f..8c1da2afc 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/cellShapeControlMesh/cellShapeControlMesh.C @@ -746,7 +746,7 @@ Foam::label Foam::cellShapeControlMesh::estimateCellCount { if (!cit->hasFarPoint() && !is_infinite(cit)) { - // @todo Check if tet centre is on the processor.. + // TODO: Check if tet centre is on the processor.. CGAL::Tetrahedron_3 tet ( cit->vertex(0)->point(), diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C index b22e27393..79e153146 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellShapeControl/controlMeshRefinement/controlMeshRefinement.C @@ -31,7 +31,7 @@ License namespace Foam { -defineTypeNameAndDebug(controlMeshRefinement, 0); + defineTypeNameAndDebug(controlMeshRefinement, 0); } // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * // @@ -396,7 +396,7 @@ void Foam::controlMeshRefinement::initialMeshPopulation << ", alignment difference = " << alignmentDiff << endl; } - // @todo Also need to base it on the alignments + // TODO: Also need to base it on the alignments if ( sizeDiff/interpolatedCellSize > 0.1 @@ -561,7 +561,7 @@ void Foam::controlMeshRefinement::initialMeshPopulation Info<< " size difference = " << sizeDiff << endl; } - // @todo Also need to base it on the alignments + // TODO: Also need to base it on the alignments if (sizeDiff/interpolatedCellSize > 0.1) { insertPoint = true; diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C index ae550bd8a..9567b8886 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMeshConformToSurface.C @@ -104,7 +104,7 @@ bool Foam::conformalVoronoiMesh::reconformToSurface() const } -// @todo Investigate topological tests +// TODO: Investigate topological tests Foam::label Foam::conformalVoronoiMesh::findVerticesNearBoundaries() { label countNearBoundaryVertices = 0; @@ -1732,7 +1732,7 @@ bool Foam::conformalVoronoiMesh::nearSurfacePoint const scalar cosAngle = angleBetweenSurfacePoints(pt, closePoint.hitPoint()); - // @todo make this tolerance run-time selectable? + // TODO: make this tolerance run-time selectable? if (cosAngle < searchAngleOppositeSurface) { pointIndexHit pCloseHit; diff --git a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C index de0e6c475..902eca86f 100644 --- a/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C +++ b/applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/searchableSurfaceFeatures/triSurfaceMeshFeatures.C @@ -91,7 +91,7 @@ Foam::triSurfaceMeshFeatures::features() const surfaceFeatures sFeat(surfMesh, includedAngle_); - // @todo Need to read on a per region basis + // TODO: Need to read on a per region basis boolList surfBaffleRegions ( surfMesh.patches().size(), diff --git a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C index 6ac1bc9ba..1cf848eec 100644 --- a/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C +++ b/applications/utilities/mesh/generation/foamyMesh/foamyQuadMesh/insertFeaturePoints.C @@ -97,7 +97,7 @@ void Foam::CV2D::insertFeaturePoints() } // Args: (base point, normal) - // @todo allow user to input this + // TODO: allow user to input this plane zPlane(vector(0, 0, z_), vector(0, 0, 1)); if (debug) diff --git a/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C b/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C index 84f00b698..9336b30d1 100644 --- a/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C +++ b/applications/utilities/surface/surfaceFeatureExtract/surfaceFeatureExtract.C @@ -375,7 +375,7 @@ triSurfacePointScalarField calcCurvature ); // Calculate weight - // @todo Voronoi area weighting + // TODO: Voronoi area weighting scalar weight = calcVertexNormalWeight ( f, diff --git a/bin/tools/doxyFilter.sed b/bin/tools/doxyFilter.sed index 3e6e921b1..9b7cfd86f 100644 --- a/bin/tools/doxyFilter.sed +++ b/bin/tools/doxyFilter.sed @@ -136,13 +136,6 @@ s/^ // } -# Remove ToDo paragraph to avoid them showing on related pages -/^To[Dd]o *$/,/^[^ ]/{ -s/^To[Dd]o *$// -s/^ .*// -} - - /^Warning *$/,/^[^ ]/{ /^Warning/c\ \\warning @@ -150,13 +143,6 @@ s/^ // } -/^Deprecated *$/,/^[^ ]/{ -/^Deprecated/c\ -\\deprecated -s/^ // -} - - /^SourceFiles *$/,/^$/{ s?SourceFiles?\\par Source files\