Fix warnings when building the documentation with Doxygen

.github/workflows/ci.yml

@@ -201,7 +201,7 @@ jobs:
       - name: Install Doxygen
         run: |
           sudo apt update
-          sudo apt install doxygen
+          sudo apt install doxygen graphviz
       - name: Install Sphinx
         run: |
           pip3 install sphinx

src/api/libcellml/generator.h

@@ -84,7 +84,7 @@ class LIBCELLML_EXPORT Generator: public Logger
      * Return the interface code for the @ref AnalyserModel, using the @ref GeneratorProfile.
      *
      * @param analyserModel The @ref AnalyserModel for which we want to generate some interface code.
-     * @param generatorProfile The @ref GeneratorProfile to use to generate the interface code.
+     * @param profile The @ref GeneratorProfile to use to generate the interface code.
      *
      * @return The interface code as a @c std::string.
      */

src/api/libcellml/generatorprofile.h

@@ -3426,27 +3426,27 @@ class LIBCELLML_EXPORT GeneratorProfile
     void setUArrayString(const std::string &uArrayString);
 
     /**
-     * @brief Get the @c std::string for the @f array used in the objective
+     * @brief Get the @c std::string for the @c f array used in the objective
      * function and find root methods.
      *
-     * Return the @c std::string for the @f array used in the objective function
+     * Return the @c std::string for the @c f array used in the objective function
      * and find root methods. The @c f array is used to keep track of the value of
      * the different objective functions in a system of non-linear algebraic equations.
      *
-     * @return The @c std::string for the @f array used in the objective function
+     * @return The @c std::string for the @c f array used in the objective function
      * and find root methods.
      */
     std::string fArrayString() const;
 
     /**
-     * @brief Set the @c std::string for the @f array used in the objective
+     * @brief Set the @c std::string for the @c f array used in the objective
      * function and find root methods.
      *
-     * Set the @c std::string for the @f array used in the objective function and
+     * Set the @c std::string for the @c f array used in the objective function and
      * find root methods. The @c f array is used to keep track of the value of the
      * different objective functions in a system of non-linear algebraic equations.
      *
-     * @param fArrayString The @c std::string to use for the @f array used in the
+     * @param fArrayString The @c std::string to use for the @c f array used in the
      * objective function and find root methods.
      */
     void setFArrayString(const std::string &fArrayString);

src/logger_p.h

@@ -47,14 +47,9 @@ class Logger::LoggerImpl
     /**
      * @brief Remove issue of level ERROR at the specified @p index.
      *
-     * Removes an error at @p index.  If @c true is returned
-     * then the error at @p index was successfully removed.
-     * If @p index is within the range [0, \#errors)
-     * then @c true is returned, otherwise @c false is returned.
+     * Removes an error at @p index.
      *
      * @param index The index of the error to remove.
-     *
-     * @return @c true if the error is removed, @c false otherwise.
      */
     void removeError(size_t index);
 

src/parser.cpp

@@ -298,7 +298,7 @@ ModelPtr Parser::ParserImpl::parseModel(const std::string &input)
  * XML identifiers in the CMETA 1.0 namespace.
  *
  * @param attribute The attribute to test.
- * @param transforming @true if transfomring from CellML 1.0 or CellML 1.1, @c false otherwise.
+ * @param transforming @c true if transfomring from CellML 1.0 or CellML 1.1, @c false otherwise.
  *
  * @return @c true if the given attribute is an XML identifier attribute, @c false otherwise.
  */