diff --git a/include/matioCpp/CellArray.h b/include/matioCpp/CellArray.h index 405f201b..02b73ce3 100644 --- a/include/matioCpp/CellArray.h +++ b/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) diff --git a/include/matioCpp/ConversionUtilities.h b/include/matioCpp/ConversionUtilities.h index 4bbc3c2f..9d3e89b0 100644 --- a/include/matioCpp/ConversionUtilities.h +++ b/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); diff --git a/include/matioCpp/Element.h b/include/matioCpp/Element.h index 7a3ca4b2..8d3e781c 100644 --- a/include/matioCpp/Element.h +++ b/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& operator=(element_type value); diff --git a/include/matioCpp/File.h b/include/matioCpp/File.h index f1b7affd..65b3a629 100644 --- a/include/matioCpp/File.h +++ b/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 diff --git a/include/matioCpp/MatvarHandler.h b/include/matioCpp/MatvarHandler.h index 2393f6c7..7f6222d5 100644 --- a/include/matioCpp/MatvarHandler.h +++ b/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 pointerToDeallocate); diff --git a/include/matioCpp/MultiDimensionalArray.h b/include/matioCpp/MultiDimensionalArray.h index 9456cb91..201753e5 100644 --- a/include/matioCpp/MultiDimensionalArray.h +++ b/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) diff --git a/include/matioCpp/StructArray.h b/include/matioCpp/StructArray.h index 6a46f074..777de78a 100644 --- a/include/matioCpp/StructArray.h +++ b/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) diff --git a/include/matioCpp/Variable.h b/include/matioCpp/Variable.h index 51d4d72e..465c1319 100644 --- a/include/matioCpp/Variable.h +++ b/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; diff --git a/include/matioCpp/Vector.h b/include/matioCpp/Vector.h index 5efa600c..04583edf 100644 --- a/include/matioCpp/Vector.h +++ b/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);