Commit d1e43e3a authored by Paul's avatar Paul
Browse files

Formatting

parent 91570d04
...@@ -9,9 +9,10 @@ namespace rtg { ...@@ -9,9 +9,10 @@ namespace rtg {
/** /**
* @brief Arguments passed to instructions * @brief Arguments passed to instructions
* *
* An `argument` can represent a raw buffer of data that either be referenced from another element or it can be owned by the argument. * An `argument` can represent a raw buffer of data that either be referenced from another element
* * or it can be owned by the argument.
*
*/ */
struct argument : raw_data<argument> struct argument : raw_data<argument>
{ {
......
...@@ -5,7 +5,7 @@ namespace rtg { ...@@ -5,7 +5,7 @@ namespace rtg {
/** /**
* @brief Erase all elements from a container * @brief Erase all elements from a container
* *
* @param r The container to erase elements from * @param r The container to erase elements from
* @param value The value to be erased * @param value The value to be erased
* @return Returns iterator to erased element * @return Returns iterator to erased element
...@@ -18,7 +18,7 @@ auto erase(R&& r, const T& value) ...@@ -18,7 +18,7 @@ auto erase(R&& r, const T& value)
/** /**
* @brief Erase all elements from a container * @brief Erase all elements from a container
* *
* @param r The container to erase elements from * @param r The container to erase elements from
* @param pred Predicate function that selects which elements should be erased. * @param pred Predicate function that selects which elements should be erased.
* @return Returns iterator to erased element * @return Returns iterator to erased element
......
...@@ -15,7 +15,7 @@ struct exception : std::runtime_error ...@@ -15,7 +15,7 @@ struct exception : std::runtime_error
/** /**
* @brief Create an exception object * @brief Create an exception object
* *
* @param context A message that says where the exception occurred * @param context A message that says where the exception occurred
* @param message * @param message
* @return Exceptions * @return Exceptions
...@@ -27,10 +27,10 @@ inline exception make_exception(std::string context, std::string message = "") ...@@ -27,10 +27,10 @@ inline exception make_exception(std::string context, std::string message = "")
/** /**
* @brief Create a message of a file location * @brief Create a message of a file location
* *
* @param file The filename * @param file The filename
* @param line The line number * @param line The line number
* *
* @return A string that represents the file location * @return A string that represents the file location
*/ */
inline std::string make_source_context(const std::string& file, int line) inline std::string make_source_context(const std::string& file, int line)
......
...@@ -8,10 +8,11 @@ namespace rtg { ...@@ -8,10 +8,11 @@ namespace rtg {
/** /**
* @brief Provides a base class for common operations with raw buffer * @brief Provides a base class for common operations with raw buffer
* *
* For classes that handle a raw buffer of data, this will provide common operations such as equals, printing, and visitors. * For classes that handle a raw buffer of data, this will provide common operations such as equals,
* To use this class the derived class needs to provide a `data()` method to retrieve a raw pointer to the data, and `get_shape` method that provides the shape of the data. * printing, and visitors. To use this class the derived class needs to provide a `data()` method to
* * retrieve a raw pointer to the data, and `get_shape` method that provides the shape of the data.
*
*/ */
template <class Derived> template <class Derived>
struct raw_data struct raw_data
...@@ -46,7 +47,7 @@ struct raw_data ...@@ -46,7 +47,7 @@ struct raw_data
/** /**
* @brief Visits a single data element at a certain index. * @brief Visits a single data element at a certain index.
* *
* @param v A function which will be called with the type of data * @param v A function which will be called with the type of data
* @param n The index to read from * @param n The index to read from
*/ */
...@@ -60,9 +61,9 @@ struct raw_data ...@@ -60,9 +61,9 @@ struct raw_data
/** /**
* @brief Visits the data * @brief Visits the data
* *
* This will call the visitor function with a `tensor_view<T>` based on the shape of the data. * This will call the visitor function with a `tensor_view<T>` based on the shape of the data.
* *
* @param v A function to be called with `tensor_view<T>` * @param v A function to be called with `tensor_view<T>`
*/ */
template <class Visitor> template <class Visitor>
...@@ -82,7 +83,7 @@ struct raw_data ...@@ -82,7 +83,7 @@ struct raw_data
/** /**
* @brief Retrieves a single element of data * @brief Retrieves a single element of data
* @details [long description] * @details [long description]
* *
* @param n The index to retrieve the data from * @param n The index to retrieve the data from
* @tparam T The type of data to be retrieved * @tparam T The type of data to be retrieved
* @return The element as `T` * @return The element as `T`
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment