From 382151cf63ff5ef3144fc38bb87490d33da7b2d3 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sun, 11 Jan 2009 11:28:32 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@619 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- src/include/debug.h | 4 ++-- src/include/events.h | 14 +++++++------- src/include/lists.h | 6 +++--- src/include/mutexes.h | 6 +++--- src/include/scheduler.h | 6 +++--- src/include/serial.h | 22 +++++++++++----------- src/include/sys.h | 2 +- src/include/threads.h | 48 ++++++++++++++++++++++++------------------------ src/include/vt.h | 4 ++-- 9 files changed, 56 insertions(+), 56 deletions(-) (limited to 'src/include') diff --git a/src/include/debug.h b/src/include/debug.h index 6bd3845b4..52c15cf08 100644 --- a/src/include/debug.h +++ b/src/include/debug.h @@ -67,8 +67,8 @@ extern "C" { * with the specified message. * @param c the condition to be verified to be true * @param m the text message - * @note The condition is tested only if the \p CH_USE_DEBUG switch is - * specified in \p chconf.h else the macro does nothing. + * @note The condition is tested only if the @p CH_USE_DEBUG switch is + * specified in @p chconf.h else the macro does nothing. */ #define chDbgAssert(c, m) { \ if (!(c)) \ diff --git a/src/include/events.h b/src/include/events.h index 49b551f45..1f2e2a15a 100644 --- a/src/include/events.h +++ b/src/include/events.h @@ -57,16 +57,16 @@ typedef struct EventSource { /** * Initializes an Event Source. - * @param esp pointer to the \p EventSource structure + * @param esp pointer to the @p EventSource structure * @note Can be called with interrupts disabled or enabled. */ #define chEvtInit(esp) \ ((esp)->es_next = (EventListener *)(void *)(esp)) /** - * Verifies if there is at least one \p EventListener registered on the - * \p EventSource. - * @param esp pointer to the \p EventSource structure + * Verifies if there is at least one @p EventListener registered on the + * @p EventSource. + * @param esp pointer to the @p EventSource structure * @note Can be called with interrupts disabled or enabled. */ #define chEvtIsListening(esp) \ @@ -101,12 +101,12 @@ extern "C" { /** * Registers an Event Listener on an Event Source. - * @param esp pointer to the \p EventSource structure - * @param elp pointer to the \p EventListener structure + * @param esp pointer to the @p EventSource structure + * @param elp pointer to the @p EventListener structure * @param eid numeric identifier assigned to the Event Listener. The identifier * is used as index for the event callback function. * The value must range between zero and the size, in bit, of the - * \p eventid_t type minus one. + * @p eventid_t type minus one. * @note Multiple Event Listeners can use the same event identifier, the * listener will share the callback function. */ diff --git a/src/include/lists.h b/src/include/lists.h index 5f4a73d67..10b5d7823 100644 --- a/src/include/lists.h +++ b/src/include/lists.h @@ -36,9 +36,9 @@ typedef struct Thread Thread; * @extends ThreadsList */ typedef struct { - /** First \p Thread in the queue, or \p ThreadQueue when empty. */ + /** First @p Thread in the queue, or @p ThreadQueue when empty. */ Thread *p_next; - /** Last \p Thread in the queue, or \p ThreadQueue when empty. */ + /** Last @p Thread in the queue, or @p ThreadQueue when empty. */ Thread *p_prev; } ThreadsQueue; @@ -46,7 +46,7 @@ typedef struct { * Generic threads single link list, it works like a stack. */ typedef struct { - /** Last pushed \p Thread on the stack list, or \p ThreadList when empty. */ + /** Last pushed @p Thread on the stack list, or @p ThreadList when empty. */ Thread *p_next; } ThreadsList; diff --git a/src/include/mutexes.h b/src/include/mutexes.h index e4ddcfb43..247b5ad7c 100644 --- a/src/include/mutexes.h +++ b/src/include/mutexes.h @@ -33,9 +33,9 @@ typedef struct Mutex { /** Queue of the threads sleeping on this Mutex.*/ ThreadsQueue m_queue; - /** Owner \p Thread pointer or \p NULL.*/ + /** Owner @p Thread pointer or @p NULL.*/ Thread *m_owner; - /** Next \p Mutex into an owner-list, \p NULL if none.*/ + /** Next @p Mutex into an owner-list, @p NULL if none.*/ struct Mutex *m_next; } Mutex; @@ -55,7 +55,7 @@ extern "C" { #endif /** - * Returns \p TRUE if the mutex queue contains at least a waiting thread. + * Returns @p TRUE if the mutex queue contains at least a waiting thread. */ #define chMtxQueueNotEmptyS(mp) notempty(&(mp)->m_queue) diff --git a/src/include/scheduler.h b/src/include/scheduler.h index f4dac7d16..7d2f95beb 100644 --- a/src/include/scheduler.h +++ b/src/include/scheduler.h @@ -25,7 +25,7 @@ #ifndef _SCHEDULER_H_ #define _SCHEDULER_H_ -/** Normal \p chSchReadyI() message. */ +/** Normal @p chSchReadyI() message. */ #define RDY_OK 0 /** Returned when the thread was made ready because of a timeout. */ #define RDY_TIMEOUT -1 @@ -57,9 +57,9 @@ * @extends ThreadsQueue */ typedef struct { - /** Next \p Thread in the ready list.*/ + /** Next @p Thread in the ready list.*/ Thread *p_next; - /** Previous \p Thread in the ready list.*/ + /** Previous @p Thread in the ready list.*/ Thread *p_prev; /* End of the fields shared with the ThreadsQueue structure. */ /** The thread priority.*/ diff --git a/src/include/serial.h b/src/include/serial.h index 25dcfa9ec..0dfd02c56 100644 --- a/src/include/serial.h +++ b/src/include/serial.h @@ -53,21 +53,21 @@ typedef struct { /** Input queue. Incoming data can be read from this queue by using the * queues APIs.*/ Queue sd_iqueue; - /** Data Available \p EventSource. This event is generated when some incoming - * data is inserted in the Input \p Queue.*/ + /** Data Available @p EventSource. This event is generated when some incoming + * data is inserted in the Input @p Queue.*/ EventSource sd_ievent; - /** Output queue. Outgoing data can be written to this Output \p Queue by + /** Output queue. Outgoing data can be written to this Output @p Queue by * using the queues APIs.*/ Queue sd_oqueue; - /** Data Transmitted \p EventSource. This event is generated when the - * Output \p Queue is empty.*/ + /** Data Transmitted @p EventSource. This event is generated when the + * Output @p Queue is empty.*/ EventSource sd_oevent; /** I/O driver status flags. This field should not be read directly but - * the \p chFDDGetAndClearFlags() funtion should be used instead.*/ + * the @p chFDDGetAndClearFlags() funtion should be used instead.*/ dflags_t sd_flags; - /** Status Change \p EventSource. This event is generated when a + /** Status Change @p EventSource. This event is generated when a * condition flag was changed.*/ EventSource sd_sevent; } FullDuplexDriver; @@ -115,17 +115,17 @@ extern "C" { */ typedef struct { - /** Data queue. Transmit/receive \p HalfDuplexQueue.*/ + /** Data queue. Transmit/receive @p HalfDuplexQueue.*/ HalfDuplexQueue sd_queue; - /** Data Available \p EventSource. This event is generated when some + /** Data Available @p EventSource. This event is generated when some * incoming data is inserted in the receive queue.*/ EventSource sd_ievent; - /** Data Transmitted \p EventSource. This event is generated when the + /** Data Transmitted @p EventSource. This event is generated when the * transmission queue is empty and the driver can either transmit more * data or enter receive mode.*/ EventSource sd_oevent; /** I/O driver status flags. This field should not be read directly but - * the \p chHDDGetAndClearFlags() funtion should be used + * the @p chHDDGetAndClearFlags() funtion should be used * instead.*/ dflags_t sd_flags; /** Status Change Event Source. This event is generated when a condition diff --git a/src/include/sys.h b/src/include/sys.h index ae6a8dd2a..5acc863f2 100644 --- a/src/include/sys.h +++ b/src/include/sys.h @@ -154,7 +154,7 @@ * IRQ handler exit code. * @note Usually IRQ handlers function are also declared naked. * @note This macro usually performs the final reschedulation by using - * \p chSchRescRequiredI() and \p chSchDoRescheduleI(). + * @p chSchRescRequiredI() and @p chSchDoRescheduleI(). */ #define CH_IRQ_EPILOGUE() SYS_IRQ_EPILOGUE() diff --git a/src/include/threads.h b/src/include/threads.h index 771fabb83..cd3856b34 100644 --- a/src/include/threads.h +++ b/src/include/threads.h @@ -30,13 +30,13 @@ * @extends ThreadsQueue * @note Not all the listed fields are always needed, by switching off some * not needed ChibiOS/RT subsystems it is possible to save RAM space by - * shrinking the \p Thread structure. + * shrinking the @p Thread structure. */ struct Thread { - /** Next \p Thread in the threads list.*/ + /** Next @p Thread in the threads list.*/ Thread *p_next; /* End of the fields shared with the ThreadsList structure. */ - /** Previous \p Thread in the threads list.*/ + /** Previous @p Thread in the threads list.*/ Thread *p_prev; /* End of the fields shared with the ThreadsQueue structure. */ /** The thread priority.*/ @@ -59,28 +59,28 @@ struct Thread { * thread in the system. */ union { - /** Thread wakeup code (only valid when exiting the \p PRREADY state).*/ + /** Thread wakeup code (only valid when exiting the @p PRREADY state).*/ msg_t p_rdymsg; - /** The thread exit code (only while in \p PREXIT state).*/ + /** The thread exit code (only while in @p PREXIT state).*/ msg_t p_exitcode; #ifdef CH_USE_SEMAPHORES - /** Semaphore where the thread is waiting on (only in \p PRWTSEM state).*/ + /** Semaphore where the thread is waiting on (only in @p PRWTSEM state).*/ Semaphore *p_wtsemp; #endif #ifdef CH_USE_MUTEXES - /** Mutex where the thread is waiting on (only in \p PRWTMTX state).*/ + /** Mutex where the thread is waiting on (only in @p PRWTMTX state).*/ Mutex *p_wtmtxp; #endif #ifdef CH_USE_CONDVARS - /** CondVar where the thread is waiting on (only in \p PRWTCOND state).*/ + /** CondVar where the thread is waiting on (only in @p PRWTCOND state).*/ CondVar *p_wtcondp; #endif #ifdef CH_USE_MESSAGES - /** Destination thread for message send (only in \p PRSNDMSG state).*/ + /** Destination thread for message send (only in @p PRSNDMSG state).*/ Thread *p_wtthdp; #endif #ifdef CH_USE_EVENTS - /** Enabled events mask (only while in \p PRWTOREVT or \p PRWTANDEVT + /** Enabled events mask (only while in @p PRWTOREVT or @p PRWTANDEVT states). */ eventmask_t p_ewmask; #endif @@ -106,7 +106,7 @@ struct Thread { eventmask_t p_epending; #endif #ifdef CH_USE_MUTEXES - /** List of mutexes owned by this thread, \p NULL terminated. */ + /** List of mutexes owned by this thread, @p NULL terminated. */ Mutex *p_mtxlist; /** Thread's own, non-inherited, priority. */ tprio_t p_realprio; @@ -129,20 +129,20 @@ struct Thread { #define PRWTSEM 3 /** Thread state: Waiting on a mutex. */ #define PRWTMTX 4 -/** Thread state: Waiting in \p chThdSleep() or \p chThdSleepUntil(). */ +/** Thread state: Waiting in @p chThdSleep() or @p chThdSleepUntil(). */ #define PRWTCOND 5 -/** Thread state: Waiting in \p chCondWait(). */ +/** Thread state: Waiting in @p chCondWait(). */ #define PRSLEEP 6 -/** Thread state: Waiting in \p chThdWait(). */ +/** Thread state: Waiting in @p chThdWait(). */ #define PRWAIT 7 -/** Thread state: Waiting in \p chEvtWaitOneTimeout() or - \p chEvtWaitAnyTimeout(). */ +/** Thread state: Waiting in @p chEvtWaitOneTimeout() or + @p chEvtWaitAnyTimeout(). */ #define PRWTOREVT 8 -/** Thread state: Waiting in \p chEvtWaitAllTimeout(). */ +/** Thread state: Waiting in @p chEvtWaitAllTimeout(). */ #define PRWTANDEVT 9 -/** Thread state: Waiting in \p chMsgSend(). */ +/** Thread state: Waiting in @p chMsgSend(). */ #define PRSNDMSG 10 -/** Thread state: Waiting in \p chMsgWait(). */ +/** Thread state: Waiting in @p chMsgWait(). */ #define PRWTMSG 11 /** Thread state: After termination.*/ #define PREXIT 12 @@ -195,16 +195,16 @@ extern "C" { } #endif -/** Returns the pointer to the \p Thread currently in execution.*/ +/** Returns the pointer to the @p Thread currently in execution.*/ #define chThdSelf() currp /** Returns the thread priority.*/ #define chThdGetPriority() (currp->p_prio) -/** Returns the pointer to the \p Thread local storage area, if any.*/ +/** Returns the pointer to the @p Thread local storage area, if any.*/ #define chThdLS() (void *)(currp + 1) -/** Verifies if the specified thread is in the \p PREXIT state.*/ +/** Verifies if the specified thread is in the @p PREXIT state.*/ #define chThdTerminated(tp) ((tp)->p_state == PREXIT) /** @@ -213,8 +213,8 @@ extern "C" { #define chThdShouldTerminate() (currp->p_flags & P_TERMINATE) /** - * Resumes a thread created with the \p P_SUSPENDED option or suspended with - * \p chThdSuspend(). + * Resumes a thread created with the @p P_SUSPENDED option or suspended with + * @p chThdSuspend(). * @param tp the pointer to the thread */ #define chThdResumeI(tp) chSchReadyI(tp) diff --git a/src/include/vt.h b/src/include/vt.h index 72385715b..04af725c9 100644 --- a/src/include/vt.h +++ b/src/include/vt.h @@ -117,10 +117,10 @@ extern "C" { #define chVTIsArmedI(vtp) ((vtp)->vt_func != NULL) /** - * Returns the number of system ticks since the \p chSysInit() invocation. + * Returns the number of system ticks since the @p chSysInit() invocation. * @return the system ticks number * @note The counter can reach its maximum and then returns to zero. - * @note This function is designed to work with the \p chThdSleepUntil(). + * @note This function is designed to work with the @p chThdSleepUntil(). */ #define chSysGetTime() (vtlist.vt_systime) -- cgit v1.2.3