From d8574c15e98a6d822135b9779717b62e4a4679ba Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sun, 15 Jan 2017 12:03:48 +0100 Subject: [PATCH 1/6] doc: core: exclude MUTEX_LOCKED from documentation --- core/include/mutex.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/core/include/mutex.h b/core/include/mutex.h index 0f7c0fd8c9..f2062629ee 100644 --- a/core/include/mutex.h +++ b/core/include/mutex.h @@ -55,11 +55,14 @@ typedef struct { #define MUTEX_INIT_LOCKED { { MUTEX_LOCKED } } /** - * @internal + * @cond INTERNAL * @brief This is the value of the mutex when locked and no threads are waiting * for it */ #define MUTEX_LOCKED ((void *)-1) +/** + * @endcond + */ /** * @brief Initializes a mutex object. From 4e068bc1a400026d78a030a21280f29af814b455 Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sun, 15 Jan 2017 12:04:43 +0100 Subject: [PATCH 2/6] doc: core: fix formatting --- core/include/thread.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/include/thread.h b/core/include/thread.h index 17e51dea21..6b1afc9cbc 100644 --- a/core/include/thread.h +++ b/core/include/thread.h @@ -87,7 +87,7 @@ * * Reading from the top down, you can see that first, stack memory for our thread * `rcv_thread` is preallocated, followed by an implementation of the thread's - * function. Communication between threads is done using @ref core_msg: in this + * function. Communication between threads is done using @ref core_msg. In this * case, `rcv_thread` will print the process id of each thread that sent a * message to `rcv_thread`. * From cafafd57443ed2b02e9dbb602fa334a2f7992dfe Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sun, 15 Jan 2017 12:26:54 +0100 Subject: [PATCH 3/6] doc: escape hash character --- doc/doxygen/src/mainpage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/doxygen/src/mainpage.md b/doc/doxygen/src/mainpage.md index 018a4d3683..90a833bda2 100644 --- a/doc/doxygen/src/mainpage.md +++ b/doc/doxygen/src/mainpage.md @@ -43,7 +43,7 @@ RIOT is developed by an open community that anyone is welcome to join: - Follow us on [Twitter](https://twitter.com/RIOT_OS) for news from the RIOT community. - Contact us on IRC for live support and discussions: - [irc.freenode.org #riot-os](irc://irc.freenode.org/riot-os) + [irc.freenode.org \#riot-os](irc://irc.freenode.org/riot-os) The quickest start {#the-quickest-start} From 02077356d004326156696709e88ca7e8e8d55905 Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sun, 15 Jan 2017 12:27:18 +0100 Subject: [PATCH 4/6] doc: create additional group for utils --- doc.txt | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc.txt b/doc.txt index 8867c08710..cea21b4a26 100644 --- a/doc.txt +++ b/doc.txt @@ -1,11 +1,30 @@ +/** + * @defgroup utils Utilities + * @brief Utilities and helper functionality + * + * Additional scripts and configuration options to ease RIOT + * development. + * @{ + */ + /** * @def DEVELHELP * @brief This global macro activates some behavior that helps you while * developing but is otherwise optimized out. */ +#if DOXYGEN +# define DEVELHELP +#endif /** * @def TEST_SUITES * @brief This global macro activates functionality that is needed for * automated testing but not needed otherwise. */ +#if DOXYGEN +# define TEST_SUITES +#endif + +/** + * @} + */ From aac54d5a133e945a4d0b027ce647145a145b3742 Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sun, 15 Jan 2017 12:44:14 +0100 Subject: [PATCH 5/6] doc: pkg: ccn-lite: fix documentation --- pkg/ccn-lite/ccn-lite-riot.h | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/pkg/ccn-lite/ccn-lite-riot.h b/pkg/ccn-lite/ccn-lite-riot.h index 0327c8ba95..d172518980 100644 --- a/pkg/ccn-lite/ccn-lite-riot.h +++ b/pkg/ccn-lite/ccn-lite-riot.h @@ -108,6 +108,9 @@ extern "C" { #define free_3ptr_list(a,b,c) ccnl_free(a), ccnl_free(b), ccnl_free(c) #define free_4ptr_list(a,b,c,d) ccnl_free(a), ccnl_free(b), ccnl_free(c), ccnl_free(d); #define free_5ptr_list(a,b,c,d,e) ccnl_free(a), ccnl_free(b), ccnl_free(c), ccnl_free(d), ccnl_free(e); +/** + * @} + */ /** * Frees all memory directly and indirectly allocated for prefix information @@ -131,10 +134,13 @@ extern "C" { */ #define CCNL_QUEUE_SIZE (8) +/** + * @brief Data structure for interest packet + */ typedef struct { - struct ccnl_prefix_s *prefix; - unsigned char *buf; - size_t buflen; + struct ccnl_prefix_s *prefix; /**< requested prefix */ + unsigned char *buf; /**< buffer to store the interest packet */ + size_t buflen; /**< size of the buffer */ } ccnl_interest_t; @@ -216,9 +222,11 @@ struct ccnl_interest_s *ccnl_send_interest(struct ccnl_prefix_s *prefix, /** * @brief Wait for incoming content chunk * - * @pre The thread has to register for CCNL_CONT_CHUNK in @ref netreg first + * @pre The thread has to register for CCNL_CONT_CHUNK in @ref net_gnrc_netreg + * first * - * @post The thread should unregister from @ref netreg after this function returns + * @post The thread should unregister from @ref net_gnrc_netreg after this + * function returns * * @param[out] buf Buffer to stores the received content * @param[in] buf_len Size of @p buf @@ -242,6 +250,16 @@ int ccnl_wait_for_chunk(void *buf, size_t buf_len, uint64_t timeout); int ccnl_fib_add_entry(struct ccnl_relay_s *relay, struct ccnl_prefix_s *pfx, struct ccnl_face_s *face); +/** + * @brief Remove entry from the CCN-Lite FIB + * + * @par[in] relay Local relay struct + * @par[in] pfx Prefix of the FIB entry, may be NULL + * @par[in] face Face for the FIB entry, may be NULL + * + * @return 0 on success + * @return -1 on error + */ int ccnl_fib_rem_entry(struct ccnl_relay_s *relay, struct ccnl_prefix_s *pfx, struct ccnl_face_s *face); /** From d65d339059939585406f616c37a0252b6d10a332 Mon Sep 17 00:00:00 2001 From: Oleg Hahm Date: Sun, 15 Jan 2017 13:06:13 +0100 Subject: [PATCH 6/6] doc: native: do not parse internal functions --- cpu/native/include/native_internal.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/cpu/native/include/native_internal.h b/cpu/native/include/native_internal.h index 4f0b3ad840..b2778f056e 100644 --- a/cpu/native/include/native_internal.h +++ b/cpu/native/include/native_internal.h @@ -61,6 +61,7 @@ extern "C" { typedef void (*_native_callback_t)(void); /** + * @cond INTERNAL * internal functions */ void native_cpu_init(void); @@ -159,6 +160,10 @@ ssize_t _native_read(int fd, void *buf, size_t count); ssize_t _native_write(int fd, const void *buf, size_t count); ssize_t _native_writev(int fildes, const struct iovec *iov, int iovcnt); +/** + * @endcond + */ + /** * register interrupt handler handler for interrupt sig */