deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

[doc] Give files a common structure by placing license first (partial)

Browse source 
Followed by doxyen file and group tags.
This patch is only a first attempt to make provide a clean structure,
many more files require rework, too.
This commit is contained in:
Enrico Joerns 2014-11-08 01:15:42 +01:00
parent b0206e2f58
commit 85b494c16b
141 changed files with 2026 additions and 1994 deletions
Download patch file Download diff file Expand all files Collapse all files

78
core/sys/timer.h
View file

@ -1,42 +1,3 @@
/** \addtogroup sys
* @{ */
/**
* \defgroup timer Timer library
*
* The Contiki kernel does not provide support for timed
* events. Rather, an application that wants to use timers needs to
* explicitly use the timer library.
*
* The timer library provides functions for setting, resetting and
* restarting timers, and for checking if a timer has expired. An
* application must "manually" check if its timers have expired; this
* is not done automatically.
*
* A timer is declared as a \c struct \c timer and all access to the
* timer is made by a pointer to the declared timer.
*
* \note The timer library is not able to post events when a timer
* expires. The \ref etimer "Event timers" should be used for this
* purpose.
*
* \note The timer library uses the \ref clock "Clock library" to
* measure time. Intervals should be specified in the format used by
* the clock library.
*
* \sa \ref etimer "Event timers"
*
* @{
*/
/**
* \file
* Timer library header file.
* \author
* Adam Dunkels <adam@sics.se>
*/
/*
* Copyright (c) 2004, Swedish Institute of Computer Science.
* All rights reserved.
@ -70,6 +31,45 @@
* Author: Adam Dunkels <adam@sics.se>
*
*/
/**
* \file
* Timer library header file.
* \author
* Adam Dunkels <adam@sics.se>
*/
/** \addtogroup sys
* @{ */
/**
* \defgroup timer Timer library
*
* The Contiki kernel does not provide support for timed
* events. Rather, an application that wants to use timers needs to
* explicitly use the timer library.
*
* The timer library provides functions for setting, resetting and
* restarting timers, and for checking if a timer has expired. An
* application must "manually" check if its timers have expired; this
* is not done automatically.
*
* A timer is declared as a \c struct \c timer and all access to the
* timer is made by a pointer to the declared timer.
*
* \note The timer library is not able to post events when a timer
* expires. The \ref etimer "Event timers" should be used for this
* purpose.
*
* \note The timer library uses the \ref clock "Clock library" to
* measure time. Intervals should be specified in the format used by
* the clock library.
*
* \sa \ref etimer "Event timers"
*
* @{
*/
#ifndef TIMER_H_
#define TIMER_H_