fixed documentation typos.

This commit is contained in:
nvt-se 2008-10-14 12:46:39 +00:00
parent fc1a8575d6
commit 775b8b4ae5
9 changed files with 26 additions and 26 deletions

View file

@ -56,7 +56,7 @@
* *
* This file is part of the Contiki desktop environment * This file is part of the Contiki desktop environment
* *
* $Id: dsc.h,v 1.3 2007/08/30 14:39:17 matsutsuka Exp $ * $Id: dsc.h,v 1.4 2008/10/14 12:46:39 nvt-se Exp $
* *
*/ */
#ifndef __DSC_H__ #ifndef __DSC_H__
@ -96,7 +96,7 @@ struct dsc {
}; };
/** /**
* Intantiating macro for the DSC structure. * Instantiating macro for the DSC structure.
* *
* \param dscname The name of the C variable which is to contain the * \param dscname The name of the C variable which is to contain the
* DSC. * DSC.

View file

@ -28,7 +28,7 @@
* *
* This file is part of the Contiki operating system. * This file is part of the Contiki operating system.
* *
* $Id: energest.h,v 1.2 2008/09/29 11:44:37 joxe Exp $ * $Id: energest.h,v 1.3 2008/10/14 12:46:39 nvt-se Exp $
*/ */
/** /**
@ -44,7 +44,7 @@
#include "sys/rtimer.h" #include "sys/rtimer.h"
typedef struct { typedef struct {
/* unsigned long cummulative[2];*/ /* unsigned long cumulative[2];*/
unsigned long current; unsigned long current;
} energest_t; } energest_t;

View file

@ -30,7 +30,7 @@
* *
* Author: Adam Dunkels <adam@sics.se> * Author: Adam Dunkels <adam@sics.se>
* *
* $Id: lc-switch.h,v 1.2 2007/03/28 19:52:50 adamdunkels Exp $ * $Id: lc-switch.h,v 1.3 2008/10/14 12:46:39 nvt-se Exp $
*/ */
/** /**
@ -40,14 +40,14 @@
/** /**
* \file * \file
* Implementation of local continuations based on switch() statment * Implementation of local continuations based on switch() statement
* \author Adam Dunkels <adam@sics.se> * \author Adam Dunkels <adam@sics.se>
* *
* This implementation of local continuations uses the C switch() * This implementation of local continuations uses the C switch()
* statement to resume execution of a function somewhere inside the * statement to resume execution of a function somewhere inside the
* function's body. The implementation is based on the fact that * function's body. The implementation is based on the fact that
* switch() statements are able to jump directly into the bodies of * switch() statements are able to jump directly into the bodies of
* control structures such as if() or while() statmenets. * control structures such as if() or while() statements.
* *
* This implementation borrows heavily from Simon Tatham's coroutines * This implementation borrows heavily from Simon Tatham's coroutines
* implementation in C: * implementation in C:

View file

@ -49,7 +49,7 @@
* *
* This file is part of the Contiki desktop OS * This file is part of the Contiki desktop OS
* *
* $Id: loader.h,v 1.1 2006/06/17 22:41:20 adamdunkels Exp $ * $Id: loader.h,v 1.2 2008/10/14 12:46:39 nvt-se Exp $
* *
*/ */
#ifndef __LOADER_H__ #ifndef __LOADER_H__
@ -76,7 +76,7 @@
* Load and execute a program. * Load and execute a program.
* *
* This macro is used for loading and executing a program, and * This macro is used for loading and executing a program, and
* requires support from the architecture dependant code. The actual * requires support from the architecture dependent code. The actual
* program loading is made by architecture specific functions. * program loading is made by architecture specific functions.
* *
* \note A program loaded with LOADER_LOAD() must call the * \note A program loaded with LOADER_LOAD() must call the

View file

@ -30,7 +30,7 @@
* *
* Author: Adam Dunkels <adam@sics.se> * Author: Adam Dunkels <adam@sics.se>
* *
* $Id: mt.h,v 1.5 2008/05/27 14:00:09 adamdunkels Exp $ * $Id: mt.h,v 1.6 2008/10/14 12:46:39 nvt-se Exp $
*/ */
/** \addtogroup sys /** \addtogroup sys
@ -43,7 +43,7 @@
* The event driven Contiki kernel does not provide multi-threading * The event driven Contiki kernel does not provide multi-threading
* by itself - instead, preemptive multi-threading is implemented * by itself - instead, preemptive multi-threading is implemented
* as a library that optionally can be linked with applications. This * as a library that optionally can be linked with applications. This
* library constists of two parts: a platform independent part, which is * library consists of two parts: a platform independent part, which is
* the same for all platforms on which Contiki runs, and a platform * the same for all platforms on which Contiki runs, and a platform
* specific part, which must be implemented specifically for the * specific part, which must be implemented specifically for the
* platform that the multi-threading library should run. * platform that the multi-threading library should run.
@ -56,7 +56,7 @@
* @{ * @{
* *
* The Contiki multi-threading library requires some architecture * The Contiki multi-threading library requires some architecture
* specific support for seting up and switching stacks. This support * specific support for setting up and switching stacks. This support
* requires four stack manipulation functions to be implemented: * requires four stack manipulation functions to be implemented:
* mtarch_start(), which sets up the stack frame for a new thread, * mtarch_start(), which sets up the stack frame for a new thread,
* mtarch_exec(), which switches in the stack of a thread, * mtarch_exec(), which switches in the stack of a thread,
@ -66,9 +66,9 @@
* (if any) must be implemented: mtarch_pstart() and mtarch_pstop(). * (if any) must be implemented: mtarch_pstart() and mtarch_pstop().
* If no preemption is used, these functions can be implemented as * If no preemption is used, these functions can be implemented as
* empty functions. Finally, the function mtarch_init() is called by * empty functions. Finally, the function mtarch_init() is called by
* mt_init(), and can be used for initalization of timer interrupts, * mt_init(), and can be used for initialization of timer interrupts,
* or any other mechanisms required for correct operation of the * or any other mechanisms required for correct operation of the
* architecture specific support funcions while mtarch_remove() is * architecture specific support functions while mtarch_remove() is
* called by mt_remove() to clean up those resources. * called by mt_remove() to clean up those resources.
* *
*/ */
@ -101,7 +101,7 @@ struct mtarch_thread;
* This function is implemented by the architecture specific functions * This function is implemented by the architecture specific functions
* for the multi-thread library and is called by the mt_init() * for the multi-thread library and is called by the mt_init()
* function as part of the initialization of the library. The * function as part of the initialization of the library. The
* mtarch_init() function can be used for, e.g., starting preemtion * mtarch_init() function can be used for, e.g., starting preemption
* timers or other architecture specific mechanisms required for the * timers or other architecture specific mechanisms required for the
* operation of the library. * operation of the library.
*/ */

View file

@ -28,7 +28,7 @@
* *
* This file is part of the Contiki operating system. * This file is part of the Contiki operating system.
* *
* @(#)$Id: process.h,v 1.15 2008/02/07 23:04:35 oliverschmidt Exp $ * @(#)$Id: process.h,v 1.16 2008/10/14 12:46:39 nvt-se Exp $
*/ */
/** /**
@ -257,7 +257,7 @@ typedef unsigned char process_num_events_t;
/** @} */ /** @} */
/** /**
* \name Process declaration and definion * \name Process declaration and definition
* @{ * @{
*/ */
@ -294,7 +294,7 @@ static PT_THREAD(process_thread_##name(struct pt *process_pt, \
* and a human readable string name, which is used when debugging. * and a human readable string name, which is used when debugging.
* *
* \param name The variable name of the process structure. * \param name The variable name of the process structure.
* \param strname The string repressentation of the process' name. * \param strname The string representation of the process' name.
* *
* \hideinitializer * \hideinitializer
*/ */
@ -340,7 +340,7 @@ CCIF void process_start(struct process *p, const char *arg);
* *
* \param ev The event to be posted. * \param ev The event to be posted.
* *
* \param data The auxillary data to be sent with the event * \param data The auxiliary data to be sent with the event
* *
* \param p The process to which the event should be posted, or * \param p The process to which the event should be posted, or
* PROCESS_BROADCAST if the event should be posted to all processes. * PROCESS_BROADCAST if the event should be posted to all processes.

View file

@ -30,7 +30,7 @@
* *
* Author: Adam Dunkels <adam@sics.se> * Author: Adam Dunkels <adam@sics.se>
* *
* $Id: pt-sem.h,v 1.1 2006/06/17 22:41:20 adamdunkels Exp $ * $Id: pt-sem.h,v 1.2 2008/10/14 12:46:39 nvt-se Exp $
*/ */
/** /**
@ -48,7 +48,7 @@
* checks the semaphore counter and blocks the thread if the counter * checks the semaphore counter and blocks the thread if the counter
* is zero. The "signal" operation increases the semaphore counter but * is zero. The "signal" operation increases the semaphore counter but
* does not block. If another thread has blocked waiting for the * does not block. If another thread has blocked waiting for the
* semaphore that is signalled, the blocked thread will become * semaphore that is signaled, the blocked thread will become
* runnable again. * runnable again.
* *
* Semaphores can be used to implement other, more structured, * Semaphores can be used to implement other, more structured,

View file

@ -30,7 +30,7 @@
* *
* Author: Adam Dunkels <adam@sics.se> * Author: Adam Dunkels <adam@sics.se>
* *
* $Id: pt.h,v 1.2 2006/09/26 20:57:58 adamdunkels Exp $ * $Id: pt.h,v 1.3 2008/10/14 12:46:39 nvt-se Exp $
*/ */
/** /**
@ -259,7 +259,7 @@ struct pt {
/** /**
* Schedule a protothread. * Schedule a protothread.
* *
* This function shedules a protothread. The return value of the * This function schedules a protothread. The return value of the
* function is non-zero if the protothread is running or zero if the * function is non-zero if the protothread is running or zero if the
* protothread has exited. * protothread has exited.
* *

View file

@ -2,7 +2,7 @@
* \defgroup rt Real-time task scheduling * \defgroup rt Real-time task scheduling
* *
* The real-time module handles the scheduling and execution of * The real-time module handles the scheduling and execution of
* real-time tasks (with predictible execution times). * real-time tasks (with predictable execution times).
* *
* @{ * @{
*/ */
@ -45,7 +45,7 @@
* *
* This file is part of the Contiki operating system. * This file is part of the Contiki operating system.
* *
* @(#)$Id: rtimer.h,v 1.6 2007/10/23 20:33:19 adamdunkels Exp $ * @(#)$Id: rtimer.h,v 1.7 2008/10/14 12:46:39 nvt-se Exp $
*/ */
#ifndef __RTIMER_H__ #ifndef __RTIMER_H__
#define __RTIMER_H__ #define __RTIMER_H__
@ -66,7 +66,7 @@ struct rtimer;
typedef void (* rtimer_callback_t)(struct rtimer *t, void *ptr); typedef void (* rtimer_callback_t)(struct rtimer *t, void *ptr);
/** /**
* \brief Repressentation of a real-time task * \brief Representation of a real-time task
* *
* This structure represents a real-time task and is used * This structure represents a real-time task and is used
* by the real-time module and the architecture specific * by the real-time module and the architecture specific