! Work in progress !
TODO
TODO
TODO
Class-level documentation is made of the following sequence of sections (if applicable). Corresponding Doxygen commands or aliases, if any, are provided between braces.
@ingroup
)@brief
)@tparam
)@details
)@warning
)@tspecialization
TODO)@satisfies
)\par Example\ilinebr
)@see
)@note
)Helper classes are not part of the class documentation, because grouping is made at the module level (see dedicated section above).
Methods are gathered in groups with predefined names and ordering (if applicable), as follows:
assign()
methods (\ilinebr \}\ilinebr \name Construction\ilinebr \{
)size()
and reshape()
(\ilinebr \}\ilinebr \name Properties\ilinebr \{\ilinebr
)operator[]()
and data()
(\ilinebr \}\ilinebr \name Element access\ilinebr \{\ilinebr
)begin()
and end()
(\ilinebr \}\ilinebr \name Iterators\ilinebr \{\ilinebr
)slice()
and entry()
(\ilinebr \}\ilinebr \name Views\ilinebr \{\ilinebr
)apply()
and operator+=()
(\ilinebr \}\ilinebr \name Data modifiers\ilinebr \{\ilinebr
)find()
and operator+()
(\ilinebr \}\ilinebr \name Operations\ilinebr \{\ilinebr
)Each method is documented as:
@brief
)@tparam
)@param
)@details
)@warning
)@tspecialization
)@see
)\par Example\ilinebr
)@note
)Some items can be skiped, for example the parameters if names are explicit or standard enough, or the template parameters if they should not be explicitely given by the user.
Fuctions are documented similarly to methods, with a few additional items:
@ingroup
) or associated class (@relates
)@brief
)@tparam
)@param
)@details
)@warning
)@tspecialization
)@see
)\par Example\ilinebr
)@note
)