Merge pull request #35 from dic-iit/fix/documentation

Fix of documentations.

include/matioCpp/CellArray.h

@@ -122,7 +122,7 @@ class matioCpp::CellArray : public matioCpp::Variable
 
     /**
      * @brief Get the indices given the raw index
-     * @paragraph rawIndex The input raw index from which to compute the indices
+     * @param rawIndex The input raw index from which to compute the indices
      * @param el The output indices
 
     * @return True if successful, false otherwise (for example if rawIndex is out of bounds)

include/matioCpp/ConversionUtilities.h

@@ -34,7 +34,7 @@ bool get_types_from_matvart(const matvar_t* input, VariableType& outputVariableT
  * @brief Get the type names from the input pointer
  * @param input The input pointer
  * @param classType The class type
- * @param valueType The value type
+ * @param dataType The data type
  */
 bool get_types_names_from_matvart(const matvar_t* input, std::string &classType, std::string &dataType);
 

include/matioCpp/Element.h

@@ -100,7 +100,7 @@ class matioCpp::Element : public matioCpp::Variable
 
     /**
      * @brief Assignement operator (copy) from an element of type T.
-     * @param other The other Element.
+     * @param value The element to copy.
      * @return A reference to this Element.
      */
     Element<T>& operator=(element_type value);

include/matioCpp/File.h

@@ -165,6 +165,7 @@ class matioCpp::File
     /**
      * @brief Write a Variable to a file
      * @param variable The input variable.
+     * @param compression The compression type to be used for writing the variable.
      * @note The it performs a shallow copy of the variable.
      * @return True if successful.
      */
@@ -174,6 +175,7 @@ class matioCpp::File
      * @brief Write a Variable to a file in a batch
      * @param begin Iterator to the first element to be written
      * @param end Iterator to the first element that is not written
+     * @param compression The compression type to be used for writing the variable.
      * @return True if successful.
      */
     template <class iterator>

include/matioCpp/MatvarHandler.h

@@ -122,7 +122,7 @@ class matioCpp::MatvarHandler
 
         /**
          * @brief Constructor
-         * @param ponterToDeallocate A weak pointer toward the PointerInfo that contains the pointer to be freed.
+         * @param pointerToDeallocate A weak pointer toward the PointerInfo that contains the pointer to be freed.
          */
         Ownership(std::weak_ptr<PointerInfo> pointerToDeallocate);
 

include/matioCpp/MultiDimensionalArray.h

@@ -136,7 +136,7 @@ class matioCpp::MultiDimensionalArray : public matioCpp::Variable
 
     /**
      * @brief Get the indices given the raw index
-     * @paragraph rawIndex The input raw index from which to compute the indices
+     * @param rawIndex The input raw index from which to compute the indices
      * @param el The output indices
 
     * @return True if successful, false otherwise (for example if rawIndex is out of bounds)

include/matioCpp/StructArray.h

@@ -144,7 +144,7 @@ class matioCpp::StructArray : public matioCpp::Variable
 
     /**
      * @brief Get the indices given the raw index
-     * @paragraph rawIndex The input raw index from which to compute the indices
+     * @param rawIndex The input raw index from which to compute the indices
      * @param el The output indices
 
     * @return True if successful, false otherwise (for example if rawIndex is out of bounds)

include/matioCpp/Variable.h

@@ -178,7 +178,7 @@ class matioCpp::Variable
     /**
      * @brief Get an element of the variable, considered as a StructArray
      * @note This allocates memory, one pointer per sruct field, but the pointers point to data in the array
-     * @param index The linear index of the struct to retrieve
+     * @param linearIndex The linear index of the struct to retrieve
      * @return A Struct with a weak ownership to the underlying mat variable. This means that the data can be changed,
      * but the variable cannot be resized and the name cannot change.
      */
@@ -187,7 +187,7 @@ class matioCpp::Variable
     /**
      * @brief Get an element of the variable, considered as a StructArray
      * @note This allocates memory, one pointer per sruct field, but the pointers point to data in the array
-     * @param index The linear index of the struct to retrieve
+     * @param linearIndex The linear index of the struct to retrieve
      * @return A const Struct with a weak ownership to the underlying mat variable.
      */
     const Struct getStructArrayElement(size_t linearIndex) const;

include/matioCpp/Vector.h

@@ -70,7 +70,7 @@ class matioCpp::Vector : public matioCpp::Variable
     /**
      * @brief Constructor
      * @param name The name of the Vector
-     * @param inputVector The input data.
+     * @param dimensions The size of the Vector.
      */
     Vector(const std::string& name, index_type dimensions);