test to try to get doc working

object.h

Committer:
skyscraper
Date:
2020-03-28
Revision:
0:9b7c45516b5b
Child:
1:634c3fa7fbb6

File content as of revision 0:9b7c45516b5b:


/**
 * \brief   The function bar. 
 *
 * \details This function does something which is doing nothing. So this text
 *          is totally senseless and you really do not need to read this,
 *          because this text is basically saying nothing.
 *
 * \note    This text shall only show you, how such a \"note\" section
 *          is looking. There is nothing which really needs your notice,
 *          so you do not really need to read this section.
 *
 * \param[in]     a    Description of parameter a.
 * \param[out]    b    Description of the parameter b.
 * \param[in,out] c    Description of the parameter c.
 *
 * \return        The error return code of the function.
 *
 * \retval        ERR_SUCCESS    The function is successfully executed
 * \retval        ERR_FAILURE    An error occurred
 */
 
/**
 * Test doc
 */

/**
 * Test an object
 */
struct Object{
    /// Construct an object.
    Object();
};