test to try to get doc working

object.h

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

File content as of revision 1:634c3fa7fbb6:


/**
 * \brief   Documentation in Mbed Compiler. 
 *
 * \details Documentsion can be produced by using doxygen syntax.
 *          However documentation is based on a commit, so nothing
 *          happens until code is committed
 *
 * \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();
};