[doc] Give files a common structure by placing license first (partial)
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:
parent
b0206e2f58
commit
85b494c16b
141 changed files with 2026 additions and 1994 deletions
|
@ -1,17 +1,3 @@
|
|||
/**
|
||||
* \file
|
||||
* The program handler, used for loading programs and starting the
|
||||
* screensaver.
|
||||
* \author Adam Dunkels <adam@dunkels.com>
|
||||
*
|
||||
* The Contiki program handler is responsible for the Contiki menu and
|
||||
* the desktop icons, as well as for loading programs and displaying a
|
||||
* dialog with a message telling which program that is loading.
|
||||
*
|
||||
* The program handler also is responsible for starting the
|
||||
* screensaver when the CTK detects that it should be started.
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2003, Adam Dunkels.
|
||||
* All rights reserved.
|
||||
|
@ -46,6 +32,20 @@
|
|||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \file
|
||||
* The program handler, used for loading programs and starting the
|
||||
* screensaver.
|
||||
* \author Adam Dunkels <adam@dunkels.com>
|
||||
*
|
||||
* The Contiki program handler is responsible for the Contiki menu and
|
||||
* the desktop icons, as well as for loading programs and displaying a
|
||||
* dialog with a message telling which program that is loading.
|
||||
*
|
||||
* The program handler also is responsible for starting the
|
||||
* screensaver when the CTK detects that it should be started.
|
||||
*/
|
||||
|
||||
#include <string.h>
|
||||
#include <stdlib.h>
|
||||
|
||||
|
|
|
@ -1,8 +1,3 @@
|
|||
/**
|
||||
* \addtogroup shell
|
||||
* @{
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2008, Swedish Institute of Computer Science.
|
||||
* All rights reserved.
|
||||
|
@ -41,6 +36,11 @@
|
|||
* Adam Dunkels <adam@sics.se>
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup shell
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include "contiki.h"
|
||||
#include "shell.h"
|
||||
|
||||
|
|
|
@ -1,6 +1,3 @@
|
|||
/** \addtogroup servreghack
|
||||
* @{ */
|
||||
|
||||
/*
|
||||
* Copyright (c) 2010, Swedish Institute of Computer Science.
|
||||
* All rights reserved.
|
||||
|
@ -40,6 +37,9 @@
|
|||
* Adam Dunkels <adam@sics.se>
|
||||
*/
|
||||
|
||||
/** \addtogroup servreghack
|
||||
* @{ */
|
||||
|
||||
#include "contiki.h"
|
||||
#include "contiki-lib.h"
|
||||
#include "contiki-net.h"
|
||||
|
|
|
@ -1,26 +1,3 @@
|
|||
/** \addtogroup apps
|
||||
* @{ */
|
||||
|
||||
/**
|
||||
* \defgroup servreghack A service registration and diseemination hack
|
||||
* @{
|
||||
*
|
||||
* This application is a quick'n'dirty hack for registering,
|
||||
* disseminating, and looking up services. A service is identified by
|
||||
* an 8-bit integer between 1 and 255. Integers below 128 are reserved
|
||||
* for system services.
|
||||
*
|
||||
* A service is registered with the function
|
||||
* servreg_hack_register(). Registered services will be transmitted to
|
||||
* all neighbors that run the servreg-hack application. These will in
|
||||
* turn resend the registration to their neighbors.
|
||||
*
|
||||
* Services from neighbors are stored in a local table. Services
|
||||
* stored in the table can be looked up using a combination of the
|
||||
* servreg_hack_list() and servreg_hack_item_match() functions.
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2010, Swedish Institute of Computer Science.
|
||||
* All rights reserved.
|
||||
|
@ -60,6 +37,29 @@
|
|||
* Adam Dunkels <adam@sics.se>
|
||||
*/
|
||||
|
||||
/** \addtogroup apps
|
||||
* @{ */
|
||||
|
||||
/**
|
||||
* \defgroup servreghack A service registration and diseemination hack
|
||||
* @{
|
||||
*
|
||||
* This application is a quick'n'dirty hack for registering,
|
||||
* disseminating, and looking up services. A service is identified by
|
||||
* an 8-bit integer between 1 and 255. Integers below 128 are reserved
|
||||
* for system services.
|
||||
*
|
||||
* A service is registered with the function
|
||||
* servreg_hack_register(). Registered services will be transmitted to
|
||||
* all neighbors that run the servreg-hack application. These will in
|
||||
* turn resend the registration to their neighbors.
|
||||
*
|
||||
* Services from neighbors are stored in a local table. Services
|
||||
* stored in the table can be looked up using a combination of the
|
||||
* servreg_hack_list() and servreg_hack_item_match() functions.
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef SERVREG_HACK_H
|
||||
#define SERVREG_HACK_H
|
||||
|
||||
|
|
|
@ -1,8 +1,3 @@
|
|||
/**
|
||||
* \addtogroup shell
|
||||
* @{
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2008, Swedish Institute of Computer Science.
|
||||
* All rights reserved.
|
||||
|
@ -42,6 +37,11 @@
|
|||
* Adam Dunkels <adam@sics.se>
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup shell
|
||||
* @{
|
||||
*/
|
||||
|
||||
#include "contiki.h"
|
||||
#include "contiki-lib.h"
|
||||
|
||||
|
|
|
@ -1,23 +1,3 @@
|
|||
/** \addtogroup apps
|
||||
* @{ */
|
||||
|
||||
/**
|
||||
* \defgroup shell The Contiki shell
|
||||
* @{
|
||||
*
|
||||
* The Contiki shell provides both interactive and batch processing
|
||||
* for Contiki.
|
||||
*
|
||||
* The shell consists of two parts: the shell application and a shell
|
||||
* back-end. The shell application contains all the logic of the
|
||||
* shell, whereas the shell back-end provides I/O for the
|
||||
* shell. Examples of shell back-ends are a serial I/O shell back-end,
|
||||
* that allows the shell to operate over a serial connection, and a
|
||||
* telnet server back-end, that allows the shell to operate over a
|
||||
* TCP/IP telnet connection.
|
||||
*
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2008, Swedish Institute of Computer Science.
|
||||
* All rights reserved.
|
||||
|
@ -57,6 +37,26 @@
|
|||
* Adam Dunkels <adam@sics.se>
|
||||
*/
|
||||
|
||||
/** \addtogroup apps
|
||||
* @{ */
|
||||
|
||||
/**
|
||||
* \defgroup shell The Contiki shell
|
||||
* @{
|
||||
*
|
||||
* The Contiki shell provides both interactive and batch processing
|
||||
* for Contiki.
|
||||
*
|
||||
* The shell consists of two parts: the shell application and a shell
|
||||
* back-end. The shell application contains all the logic of the
|
||||
* shell, whereas the shell back-end provides I/O for the
|
||||
* shell. Examples of shell back-ends are a serial I/O shell back-end,
|
||||
* that allows the shell to operate over a serial connection, and a
|
||||
* telnet server back-end, that allows the shell to operate over a
|
||||
* TCP/IP telnet connection.
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef SHELL_H_
|
||||
#define SHELL_H_
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue