Add doxygen linters (#44)

Signed-off-by: Louise Poubel <[email protected]>
gazebosim · Mar 14, 2022 · 959e8e1 · 959e8e1
1 parent c7c4a54
commit 959e8e1
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -25,6 +25,7 @@ jobs:
         uses: ignition-tooling/action-ignition-ci@focal
         with:
           cpplint-enabled: true
+          doxygen-enabled: true
   jammy-ci:
     runs-on: ubuntu-latest
     name: Ubuntu Jammy CI

diff --git a/include/ignition/utils/ImplPtr.hh b/include/ignition/utils/ImplPtr.hh
@@ -48,8 +48,8 @@ namespace ignition
     /// };
     /// \endcode
     ///
-    /// When constructing the \code{dataPtr} object, pass it
-    /// \code{MakeImpl<Implementation>(/* ... args ... */)} in the
+    /// When constructing the `dataPtr` object, pass it
+    /// `MakeImpl<Implementation>(/* ... args ... */)` in the
     /// initialization list of your class. \sa MakeImpl<T>()
     ///
     /// This class was inspired by the following blog post:
@@ -224,7 +224,7 @@ namespace ignition
     /// UniqueImplPtr object's constructor will efficiently move this newly
     /// created object into it.
     template <class T, typename... Args>
-    UniqueImplPtr<T> MakeUniqueImpl(Args &&...args);
+    UniqueImplPtr<T> MakeUniqueImpl(Args &&..._args);
   }  // namespace utils
 }  // namespace ignition
 

diff --git a/include/ignition/utils/NeverDestroyed.hh b/include/ignition/utils/NeverDestroyed.hh
@@ -30,7 +30,7 @@ namespace utils
 /// Originally copied from https://github.com/RobotLocomotion/drake/blob/v0.36.0/common/never_destroyed.h
 /// Originally licensed BSD 3-Clause (https://github.com/RobotLocomotion/drake/blob/v0.36.0/LICENSE.TXT)
 /// Re-licensed Apache-2.0 with permission from:
-/// @jwnimmer-tri (https://github.com/ignitionrobotics/ign-utils/pull/31#issuecomment-989173512)
+/// jwnimmer-tri (https://github.com/ignitionrobotics/ign-utils/pull/31#issuecomment-989173512)
 ///
 /// Wraps an underlying type T such that its storage is a direct member field
 /// of this object (i.e., without any indirection into the heap), but *unlike*