psyc-mirrors/libpsyc
1
0
Fork 0
mirror of git://git.psyc.eu/libpsyc synced 2024-08-15 03:19:02 +00:00
Code Issues Releases Wiki Activity

doc

Browse source
This commit is contained in:
tg(x) 2011-05-09 14:37:57 +02:00
parent 9133214f68
commit f0b97701d0
4 changed files with 27 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
include/psyc.h
View file

@ -1,20 +1,18 @@
/** @file psyc.h /**
* * @file psyc.h
* @brief Main PSYC interface providing crucial functionality. * @brief Main PSYC interface providing crucial functionality.
*/ */
/** @mainpage PSYC Core Library /**
* @mainpage PSYC Core Library
* *
* @section intro_sec Introduction * @section intro_sec Introduction
* *
* Welcome to the libpsyc documentation! * Welcome to the libpsyc documentation!
* *
* @section install_sec Installation * @section install_sec Installation
*
* @subsection step1 Step 1: Opening the box
*
* etc...
*/ */
// * @subsection step1 Step 1: Opening the box
#ifndef PSYC_H #ifndef PSYC_H

17
include/psyc/packet.h
View file

@ -1,5 +1,20 @@
#ifndef PSYC_PACKET_H #ifndef PSYC_PACKET_H
/**
* @file psyc/packet.h
* @brief Interface for PSYC packet data structures.
*
* Packet data structures and functions for creating them are defined here.
*/
/**
* @defgroup packet Packet data structures
*
* This module contains definitions of packet data structures and functions for
* creating them.
* @{
*/
#include <psyc.h> #include <psyc.h>
#include <psyc/syntax.h> #include <psyc/syntax.h>
@ -142,5 +157,7 @@ psycPacket psyc_newRawPacket2 (psycModifier *routing, size_t routinglen,
const char *content, size_t contentlen, const char *content, size_t contentlen,
psycPacketFlag flag); psycPacketFlag flag);
/** @} */ // end of packet group
#define PSYC_PACKET_H #define PSYC_PACKET_H
#endif #endif

5
include/psyc/parse.h
View file

@ -2,10 +2,9 @@
/** /**
* @file psyc/parse.h * @file psyc/parse.h
* @brief Interface for various PSYC parsing functions. * @brief Interface for PSYC packet parsing.
* *
* All parsing functions and the definitions they use are * All parsing functions and the definitions they use are defined here.
* defined in this file.
*/ */
/** /**

5
include/psyc/render.h
View file

@ -6,8 +6,7 @@
* @file psyc/render.h * @file psyc/render.h
* @brief Interface for PSYC packet rendering. * @brief Interface for PSYC packet rendering.
* *
* All rendering functions and the definitions they use are * All rendering functions and the definitions they use are defined here.
* defined in this file.
*/ */
/** /**
@ -38,7 +37,7 @@ psycRenderRC psyc_render (psycPacket *packet, char *buffer, size_t buflen);
*/ */
psycRenderRC psyc_renderList (psycList *list, char *buffer, size_t buflen); psycRenderRC psyc_renderList (psycList *list, char *buffer, size_t buflen);
/** @} */ // end of renderer group /** @} */ // end of render group
#define PSYC_RENDER_H #define PSYC_RENDER_H
#endif #endif