Fix doxygen errors in SurfaceMesh and DigitalConvexity #1534
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phcerdan
force-pushed
the
fix_doxygen_surface
branch
from
9ea3995
to
13bb3ca
Compare
```cpp
[195/454] Building CXX object tests/geometry/volumes/CMakeFiles/testDigitalConvexity.dir/testDigitalConvexity.cpp.o
In file included from ../tests/geometry/volumes/testDigitalConvexity.cpp:38:
../src/DGtal/geometry/volumes/DigitalConvexity.h:258:14: warning: unrecognized parameter passing direction, valid directions are '[in]', '[out]' and '[in,out]' [-Wdocumentation]
* @param[inout] out the output stream where information is outputed.
^~~~~~~
../src/DGtal/geometry/volumes/DigitalConvexity.h:270:14: warning: unrecognized parameter passing direction, valid directions are '[in]', '[out]' and '[in,out]' [-Wdocumentation]
* @param[inout] out the output stream where information is outputed.
^~~~~~~
2 warnings generated.
[245/454] Building CXX object tests/geometry/surfaces/CMakeFiles/testShroudsRegularization.dir/testShroudsRegularization.cpp.o
In file included from ../tests/geometry/surfaces/testShroudsRegularization.cpp:35:
In file included from ../src/DGtal/helpers/Shortcuts.h:62:
In file included from ../src/DGtal/shapes/MeshHelpers.h:51:
../src/DGtal/shapes/SurfaceMesh.h:164:16: warning: parameter 'itPos,itPosEnd' not found in the function declaration [-Wdocumentation]
/// @param itPos,itPosEnd a range of iterators pointing on the positions of all the
^~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:167:16: warning: parameter 'itVertices,itVerticesEnd' not found in the function declaration [-Wdocumentation]
/// @param itVertices,itVerticesEnd a range of iterators pointing
^~~~~~~~~~~~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:187:16: warning: parameter 'itPos,itPosEnd' not found in the function declaration [-Wdocumentation]
/// @param itPos,itPosEnd a range of iterators pointing on the positions of all the
^~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:190:16: warning: parameter 'itVertices,itVerticesEnd' not found in the function declaration [-Wdocumentation]
/// @param itVertices,itVerticesEnd a range of iterators pointing
^~~~~~~~~~~~~~~~~~~~~~~~
In file included from ../tests/geometry/surfaces/testShroudsRegularization.cpp:36:
../src/DGtal/geometry/surfaces/ShroudsRegularization.h:63:11: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleShrouds
~~~~^
5 warnings generated.
[247/454] Building CXX object tests/geometry/surfaces/CMakeFiles/testIntegralInvariantShortcuts.dir/testIntegralInvariantShortcuts.cpp.o
In file included from ../tests/geometry/surfaces/testIntegralInvariantShortcuts.cpp:38:
In file included from ../src/DGtal/helpers/Shortcuts.h:62:
In file included from ../src/DGtal/shapes/MeshHelpers.h:51:
../src/DGtal/shapes/SurfaceMesh.h:164:16: warning: parameter 'itPos,itPosEnd' not found in the function declaration [-Wdocumentation]
/// @param itPos,itPosEnd a range of iterators pointing on the positions of all the
^~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:167:16: warning: parameter 'itVertices,itVerticesEnd' not found in the function declaration [-Wdocumentation]
/// @param itVertices,itVerticesEnd a range of iterators pointing
^~~~~~~~~~~~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:187:16: warning: parameter 'itPos,itPosEnd' not found in the function declaration [-Wdocumentation]
/// @param itPos,itPosEnd a range of iterators pointing on the positions of all the
^~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:190:16: warning: parameter 'itVertices,itVerticesEnd' not found in the function declaration [-Wdocumentation]
/// @param itVertices,itVerticesEnd a range of iterators pointing
^~~~~~~~~~~~~~~~~~~~~~~~
In file included from ../tests/geometry/surfaces/testIntegralInvariantShortcuts.cpp:39:
In file included from ../src/DGtal/helpers/ShortcutsGeometry.h:54:
../src/DGtal/dec/ATSolver2D.h:201:13: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref DiscreteExteriorCalculusFactory for creating calculus objects.
~~~~^
In file included from ../tests/geometry/surfaces/testIntegralInvariantShortcuts.cpp:39:
../src/DGtal/helpers/ShortcutsGeometry.h:1378:15: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleAT
~~~~^
../src/DGtal/helpers/ShortcutsGeometry.h:1433:15: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleAT
~~~~^
../src/DGtal/helpers/ShortcutsGeometry.h:1501:15: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleAT
~~~~^
../src/DGtal/helpers/ShortcutsGeometry.h:1556:15: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleAT
~~~~^
9 warnings generated.
[253/454] Building CXX object tests/geometry/surfaces/CMakeFiles/testDigitalSurfaceRegularization.dir/testDigitalSurfaceRegularization.cpp.o
In file included from ../tests/geometry/surfaces/testDigitalSurfaceRegularization.cpp:35:
In file included from ../src/DGtal/helpers/Shortcuts.h:62:
In file included from ../src/DGtal/shapes/MeshHelpers.h:51:
../src/DGtal/shapes/SurfaceMesh.h:164:16: warning: parameter 'itPos,itPosEnd' not found in the function declaration [-Wdocumentation]
/// @param itPos,itPosEnd a range of iterators pointing on the positions of all the
^~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:167:16: warning: parameter 'itVertices,itVerticesEnd' not found in the function declaration [-Wdocumentation]
/// @param itVertices,itVerticesEnd a range of iterators pointing
^~~~~~~~~~~~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:187:16: warning: parameter 'itPos,itPosEnd' not found in the function declaration [-Wdocumentation]
/// @param itPos,itPosEnd a range of iterators pointing on the positions of all the
^~~~~~~~~~~~~~
../src/DGtal/shapes/SurfaceMesh.h:190:16: warning: parameter 'itVertices,itVerticesEnd' not found in the function declaration [-Wdocumentation]
/// @param itVertices,itVerticesEnd a range of iterators pointing
^~~~~~~~~~~~~~~~~~~~~~~~
In file included from ../tests/geometry/surfaces/testDigitalSurfaceRegularization.cpp:36:
In file included from ../src/DGtal/helpers/ShortcutsGeometry.h:54:
../src/DGtal/dec/ATSolver2D.h:201:13: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref DiscreteExteriorCalculusFactory for creating calculus objects.
~~~~^
In file included from ../tests/geometry/surfaces/testDigitalSurfaceRegularization.cpp:36:
../src/DGtal/helpers/ShortcutsGeometry.h:1378:15: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleAT
~~~~^
../src/DGtal/helpers/ShortcutsGeometry.h:1433:15: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleAT
~~~~^
../src/DGtal/helpers/ShortcutsGeometry.h:1501:15: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleAT
~~~~^
../src/DGtal/helpers/ShortcutsGeometry.h:1556:15: warning: empty paragraph passed to '@see' command [-Wdocumentation]
/// @see \ref moduleAT
~~~~^
9 warnings generated.
```
phcerdan
force-pushed
the
fix_doxygen_surface
branch
from
13bb3ca
to
1b1febd
Compare
5 tasks
JacquesOlivierLachaud
approved these changes
Nov 23, 2020
| @@ -161,12 +161,13 @@ namespace DGtal | |||
| /// @tparam RealPointIterator any forward iterator on RealPoint. | |||
| /// @tparam VerticesIterator any forward iterator on the range of vertices defining a face. | |||
| /// | |||
| /// @param itPos,itPosEnd a range of iterators pointing on the positions of all the | |||
| /// vertices of the mesh. | |||
| /// @param itPos start of range of iterators pointing on the positions of vertices of the mesh | |||
There was a problem hiding this comment.
Weird. When you look at https://www.doxygen.nl/manual/commands.html#cmdparam
it says that you can comment multiple parameters using comma separated items.
There was a problem hiding this comment.
Otherwise your modif is fine.
There was a problem hiding this comment.
Indeed, that's confusing, maybe CI is using an old doxygen version, or a globlal doxygen option is missing? No idea.
|
The travis CI seems again blocked due to timeout, but it seems unrelated to doc warnings. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
cmakemode (otherwise, Travis C.I. will fail).