[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,37 +1,3 @@
|
|||
/** \addtogroup lib
|
||||
@{ */
|
||||
/**
|
||||
* \defgroup list Linked list library
|
||||
*
|
||||
* The linked list library provides a set of functions for
|
||||
* manipulating linked lists.
|
||||
*
|
||||
* A linked list is made up of elements where the first element \b
|
||||
* must be a pointer. This pointer is used by the linked list library
|
||||
* to form lists of the elements.
|
||||
*
|
||||
* Lists are declared with the LIST() macro. The declaration specifies
|
||||
* the name of the list that later is used with all list functions.
|
||||
*
|
||||
* Lists can be manipulated by inserting or removing elements from
|
||||
* either sides of the list (list_push(), list_add(), list_pop(),
|
||||
* list_chop()). A specified element can also be removed from inside a
|
||||
* list with list_remove(). The head and tail of a list can be
|
||||
* extracted using list_head() and list_tail(), respectively.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* \file
|
||||
* Linked list manipulation routines.
|
||||
* \author Adam Dunkels <adam@sics.se>
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* Copyright (c) 2004, Swedish Institute of Computer Science.
|
||||
* All rights reserved.
|
||||
|
@ -65,6 +31,38 @@
|
|||
* Author: Adam Dunkels <adam@sics.se>
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \file
|
||||
* Linked list manipulation routines.
|
||||
* \author Adam Dunkels <adam@sics.se>
|
||||
*
|
||||
*/
|
||||
|
||||
/** \addtogroup lib
|
||||
@{ */
|
||||
/**
|
||||
* \defgroup list Linked list library
|
||||
*
|
||||
* The linked list library provides a set of functions for
|
||||
* manipulating linked lists.
|
||||
*
|
||||
* A linked list is made up of elements where the first element \b
|
||||
* must be a pointer. This pointer is used by the linked list library
|
||||
* to form lists of the elements.
|
||||
*
|
||||
* Lists are declared with the LIST() macro. The declaration specifies
|
||||
* the name of the list that later is used with all list functions.
|
||||
*
|
||||
* Lists can be manipulated by inserting or removing elements from
|
||||
* either sides of the list (list_push(), list_add(), list_pop(),
|
||||
* list_chop()). A specified element can also be removed from inside a
|
||||
* list with list_remove(). The head and tail of a list can be
|
||||
* extracted using list_head() and list_tail(), respectively.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#ifndef LIST_H_
|
||||
#define LIST_H_
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue