doxygen: Add some missing documentation.
[paraslash.git] / para.h
diff --git a/para.h b/para.h
index 7217486..5dc3912 100644 (file)
--- a/para.h
+++ b/para.h
@@ -176,7 +176,7 @@ _static_inline_ long int para_random(unsigned max)
  */
 #define EXPR_BUILD_ASSERT(cond) (sizeof(char [1 - 2 * !(cond)]) - 1)
 
-/* &a[0] degrades to a pointer: a different type from an array */
+/** &a[0] degrades to a pointer: a different type from an array */
 #define _array_size_chk(arr) EXPR_BUILD_ASSERT(\
        !__builtin_types_compatible_p(typeof(arr), typeof(&(arr)[0])))
 /** Get the size of an array */
@@ -200,6 +200,7 @@ _static_inline_ long int para_random(unsigned max)
 /** Data that indicates an eof-condition for a fec-encoded stream. */
 #define FEC_EOF_PACKET "\xec\x0d\xcc\xfe\0\0\0\0" \
        "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0"
+/** The number of bytes of the \a FEC_EOF_PACKET. */
 #define FEC_EOF_PACKET_LEN 32
 
 /** Used to avoid a shortcoming in vim's syntax highlighting. */
@@ -228,10 +229,12 @@ _static_inline_ long int para_random(unsigned max)
        SAMPLE_FORMAT(SF_U16_LE, "16 bit unsigned, little endian"), \
        SAMPLE_FORMAT(SF_U16_BE, "16 bit unsigned, big endian"), \
 
+/** \cond */
 #define SAMPLE_FORMAT(a, b) a
 enum sample_format {SAMPLE_FORMATS};
 #undef SAMPLE_FORMAT
 #define SAMPLE_FORMAT(a, b) b
+/** \endcond */
 
 /** Debug loglevel, gets really noisy. */
 #define LL_DEBUG 0