Andy Little
/
doc_test
test to try to get doc working
object.h@2:d96d40a3858c, 2020-03-28 (annotated)
- Committer:
- skyscraper
- Date:
- Sat Mar 28 12:06:41 2020 +0000
- Revision:
- 2:d96d40a3858c
- Parent:
- 1:634c3fa7fbb6
commit3
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
skyscraper | 0:9b7c45516b5b | 1 | |
skyscraper | 0:9b7c45516b5b | 2 | /** |
skyscraper | 1:634c3fa7fbb6 | 3 | * \brief Documentation in Mbed Compiler. |
skyscraper | 0:9b7c45516b5b | 4 | * |
skyscraper | 1:634c3fa7fbb6 | 5 | * \details Documentsion can be produced by using doxygen syntax. |
skyscraper | 1:634c3fa7fbb6 | 6 | * However documentation is based on a commit, so nothing |
skyscraper | 1:634c3fa7fbb6 | 7 | * happens until code is committed |
skyscraper | 0:9b7c45516b5b | 8 | * |
skyscraper | 0:9b7c45516b5b | 9 | * \note This text shall only show you, how such a \"note\" section |
skyscraper | 0:9b7c45516b5b | 10 | * is looking. There is nothing which really needs your notice, |
skyscraper | 0:9b7c45516b5b | 11 | * so you do not really need to read this section. |
skyscraper | 0:9b7c45516b5b | 12 | * |
skyscraper | 0:9b7c45516b5b | 13 | * \param[in] a Description of parameter a. |
skyscraper | 0:9b7c45516b5b | 14 | * \param[out] b Description of the parameter b. |
skyscraper | 0:9b7c45516b5b | 15 | * \param[in,out] c Description of the parameter c. |
skyscraper | 0:9b7c45516b5b | 16 | * |
skyscraper | 0:9b7c45516b5b | 17 | * \return The error return code of the function. |
skyscraper | 0:9b7c45516b5b | 18 | * |
skyscraper | 0:9b7c45516b5b | 19 | * \retval ERR_SUCCESS The function is successfully executed |
skyscraper | 0:9b7c45516b5b | 20 | * \retval ERR_FAILURE An error occurred |
skyscraper | 0:9b7c45516b5b | 21 | */ |
skyscraper | 0:9b7c45516b5b | 22 | |
skyscraper | 0:9b7c45516b5b | 23 | /** |
skyscraper | 0:9b7c45516b5b | 24 | * Test doc |
skyscraper | 0:9b7c45516b5b | 25 | */ |
skyscraper | 0:9b7c45516b5b | 26 | |
skyscraper | 0:9b7c45516b5b | 27 | /** |
skyscraper | 0:9b7c45516b5b | 28 | * Test an object |
skyscraper | 0:9b7c45516b5b | 29 | */ |
skyscraper | 0:9b7c45516b5b | 30 | struct Object{ |
skyscraper | 0:9b7c45516b5b | 31 | /// Construct an object. |
skyscraper | 0:9b7c45516b5b | 32 | Object(); |
skyscraper | 0:9b7c45516b5b | 33 | }; |