michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: use @rst/@endrst for ReST in headers

Browse source 
Folks found the use of @rststar/@endrststar non-intuitive (wanted to use
@rststart).  The "star" was there indicating the doxygen comment lines
had a leading asterisk that needed to be stripped, but since our
commenting convention is to use the leading asterisk on continuation
lines, the leading asterisk is always there.  So, change the doxygen
alias to the more expected @rst/@endrst.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-06-25 10:44:55 -07:00 • committed by Anas Nashif
commit 8de9cc7079
6 changed files with 76 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

28
include/kernel.h
View file

@ -1045,10 +1045,10 @@ __syscall void k_thread_priority_set(k_tid_t thread, int prio);
* logic.
*
* @note
* @rststar
* @rst
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
* @endrst
*
* @param thread A thread on which to set the deadline
* @param deadline A time delta, in cycle units
@ -1066,10 +1066,10 @@ __syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
* CPUs. The thread must not be currently runnable.
*
* @note
* @rststar
* @rst
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
* @endrst
*
* @param thread Thread to operate upon
* @return Zero on success, otherwise error code
@ -1083,10 +1083,10 @@ int k_thread_cpu_mask_clear(k_tid_t thread);
* thread must not be currently runnable.
*
* @note
* @rststar
* @rst
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
* @endrst
*
* @param thread Thread to operate upon
* @return Zero on success, otherwise error code
@ -1099,10 +1099,10 @@ int k_thread_cpu_mask_enable_all(k_tid_t thread);
* The thread must not be currently runnable.
*
* @note
* @rststar
* @rst
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
* @endrst
*
* @param thread Thread to operate upon
* @param cpu CPU index
@ -1116,10 +1116,10 @@ int k_thread_cpu_mask_enable(k_tid_t thread, int cpu);
* The thread must not be currently runnable.
*
* @note
* @rststar
* @rst
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
* @endrst
*
* @param thread Thread to operate upon
* @param cpu CPU index
@ -1658,12 +1658,12 @@ static inline void *z_impl_k_timer_user_data_get(struct k_timer *timer)
* in milliseconds.
*
* @note
* @rststar
* @rst
* While this function returns time in milliseconds, it does
* not mean it has millisecond resolution. The actual resolution depends on
* :option:`CONFIG_SYS_CLOCK_TICKS_PER_SEC` config option, and with the
* default setting of 100, system time is updated in increments of 10ms.
* @endrststar
* @endrst
*
* @return Current uptime in milliseconds.
*/
@ -1705,12 +1705,12 @@ void k_disable_sys_clock_always_on(void);
* caller must handle possible rollovers.
*
* @note
* @rststar
* @rst
* While this function returns time in milliseconds, it does
* not mean it has millisecond resolution. The actual resolution depends on
* :option:`CONFIG_SYS_CLOCK_TICKS_PER_SEC` config option, and with the
* default setting of 100, system time is updated in increments of 10ms.
* @endrststar
* @endrst
*
* @return Current uptime in milliseconds.
*/