Add some more FEC source code documentation.

[paraslash.git] / vss.h

diff --git a/vss.h b/vss.h
index efabdf36915425e913176f57098f501f235c642a..abe7a5702e286b2d6998c29f1c4ae6976d721adc 100644 (file)
--- a/vss.h
+++ b/vss.h
@@ -38,11 +38,17 @@ const char *supported_audio_formats(void);
  */
 struct fec_client;
 
+/** FEC parameters requested by FEC clients. */
 struct fec_client_parms {
+       /** Number of data slices plus redundant slices. */
        uint8_t slices_per_group;
+       /** Number of slices minus number of redundant slices. */
        uint8_t data_slices_per_group;
+       /** Maximal number of bytes per slice. */
        uint16_t max_slice_bytes;
+       /** Called by vss.c when the next slice should be sent. */
        int (*send)(char *buf, size_t num_bytes, void *private_data);
+       /** Passed verbatim to \a send(). */
        void *private_data;
 };