riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #311 from OlegHahm/ccnl_doxygen

Browse Source 
doxygen improvements for ccn_lite
This commit is contained in:
Christian Mehlis 2013-11-07 01:36:51 -08:00
commit 802f782d59
2 changed files with 44 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
sys/net/ccn_lite/include/ccnl-riot.h
View File

@ -16,6 +16,21 @@
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
/**
* @defgroup ccnl CCN lite
* @ingroup net
* @brief CCN-lite, a lightweight implementation of the Content Centric
* Networking Protocol of XEROX Parc
*
* @see <a href="http://www.ccnx.org/releases/latest/doc/technical/CCNxProtocol.html">
* CCNx Protocol
* </a>
*
* @{
* @file
* @brief CCN lite interface
* @author Christian Mehlis <christian@m3hlis.de>
*/
#ifndef RIOT_CCN_COMPAT_H_
#define RIOT_CCN_COMPAT_H_
@ -43,18 +58,20 @@ typedef enum ccnl_riot_event {
#define CCNL_RIOT_CHUNK_SIZE 90
/**
* riot_ccnl_relay_start starts the ccnl relay
* @brief starts the ccnl relay
*
* to stop the relay send msg "RIOT_HALT" to this thread
* @note to stop the relay send msg "RIOT_HALT" to this thread
*/
void ccnl_riot_relay_start(void);
/**
* riot_ccnl_appserver_start starts an appication server,
* which can repy to ccn interests
* @brief starts an appication server, which can repy to ccn interests
*
* @param relay_pid the pid of the relay
*/
void ccnl_riot_appserver_start(int relay_pid);
/**
* @}
*/
#endif /* RIOT_CCN_COMPAT_H_ */

30
sys/net/ccn_lite/include/util/ccnl-riot-client.h
View File

@ -17,7 +17,18 @@
*/
/**
* riot_get high level function to fetch a file (all chunks of a file)
* @ingroup ccnl
* @{
* @file ccnl-riot-client.h
* @brief CCN high level client functions
* @author Christian Mehlis <christian@m3hlis.de>
* @}
*/
#ifndef CCNL_RIOT_CLIENT_H
#define CCNL_RIOT_CLIENT_H
/**
* @brief high level function to fetch a file (all chunks of a file)
*
* @param relay_pid pid of the relay thread
*
@ -30,11 +41,11 @@
int ccnl_riot_client_get(unsigned int relay_pid, char *name, char *reply_buf);
/**
* riot_publish high level function to publish a name, e.g. "/riot/test"
* all interest with "prefix" as prefix received by the rely
* are forwarded to this thread
* @brief high level function to publish a name, e.g. "/riot/test"
* all interest with "prefix" as prefix received by the rely
* are forwarded to this thread
*
* this function uses riot_new_face and riot_register_prefix
* @note this function uses riot_new_face and riot_register_prefix
*
* @param relay_pid pid of the relay thread
*
@ -55,7 +66,7 @@ int ccnl_riot_client_publish(unsigned int relay_pid, char *prefix, char *faceid,
char *type, unsigned char *reply_buf);
/**
* riot_new_face lower layer function to register a new face in the relay
* @brief lower layer function to register a new face in the relay
*
* @param relay_pid pid of the relay
*
@ -74,7 +85,7 @@ int ccnl_riot_client_new_face(unsigned int relay_pid, char *type, char *faceid,
unsigned char *reply_buf);
/**
* riot_register_prefix lower layer function to register a new prefix
* @brief lower layer function to register a new prefix
* in the relay
*
* @param relay_pid pid of the relay
@ -91,3 +102,8 @@ int ccnl_riot_client_new_face(unsigned int relay_pid, char *type, char *faceid,
*/
int ccnl_riot_client_register_prefix(unsigned int relay_pid, char *prefix,
char *faceid, unsigned char *reply_buf);
/**
* @}
*/
#endif /* CCNL_RIOT_CLIENT_H */