[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:
Enrico Joerns 2014-11-08 01:15:42 +01:00
parent b0206e2f58
commit 85b494c16b
141 changed files with 2026 additions and 1994 deletions

View file

@ -1,28 +1,3 @@
/**
* \addtogroup rime
* @{
*/
/**
* \defgroup rimeibc Best-effort local area broadcast
* @{
*
* The broadcast module sends packets to all local area neighbors with an a
* header that identifies the sender.
*
* The broadcast module sends a packet to all local neighbors. The
* module adds the single-hop sender address as a packet attribute to
* outgoing packets. All Rime primitives that need the identity of
* the sender in the outgoing packets use the broadcast primitive,
* either directly or indirectly through any of the other
* communication primitives that are based on the broadcast primitive.
*
* \section channels Channels
*
* The broadcast module uses 1 channel.
*
*/
/*
* Copyright (c) 2006, Swedish Institute of Computer Science.
* All rights reserved.
@ -62,6 +37,31 @@
* Adam Dunkels <adam@sics.se>
*/
/**
* \addtogroup rime
* @{
*/
/**
* \defgroup rimeibc Best-effort local area broadcast
* @{
*
* The broadcast module sends packets to all local area neighbors with an a
* header that identifies the sender.
*
* The broadcast module sends a packet to all local neighbors. The
* module adds the single-hop sender address as a packet attribute to
* outgoing packets. All Rime primitives that need the identity of
* the sender in the outgoing packets use the broadcast primitive,
* either directly or indirectly through any of the other
* communication primitives that are based on the broadcast primitive.
*
* \section channels Channels
*
* The broadcast module uses 1 channel.
*
*/
#ifndef BROADCAST_H_
#define BROADCAST_H_