doc

include/psyc.h

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

include/psyc/packet.h

@@ -1,5 +1,20 @@
 #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/syntax.h>
 
@@ -142,5 +157,7 @@ psycPacket psyc_newRawPacket2 (psycModifier *routing, size_t routinglen,
                                const char *content, size_t contentlen,
                                psycPacketFlag flag);
 
+/** @} */ // end of packet group
+
 #define PSYC_PACKET_H
 #endif

include/psyc/parse.h

@@ -2,10 +2,9 @@
 
 /**
  * @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
- * defined in this file.
+ * All parsing functions and the definitions they use are defined here.
  */
 
 /**

include/psyc/render.h

@@ -6,8 +6,7 @@
  * @file psyc/render.h
  * @brief Interface for PSYC packet rendering.
  *
- * All rendering functions and the definitions they use are
- * defined in this file.
+ * All rendering functions and the definitions they use are defined here.
  */
 
 /**
@@ -38,7 +37,7 @@ psycRenderRC psyc_render (psycPacket *packet, 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
 #endif