X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=vss.h;h=abe7a5702e286b2d6998c29f1c4ae6976d721adc;hb=a1457929be2401590a0be305a215cf770a8bd787;hp=efabdf36915425e913176f57098f501f235c642a;hpb=7565af270650435630bf212592286a8c6555d749;p=paraslash.git

diff --git a/vss.h b/vss.h
index efabdf36..abe7a570 100644
--- 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;
 };