Tidy header documentation

Trimmed overgrown lines, revised documentation

Signed-off-by: Mark Farrugia <mark.farrugia@fiberdyne.com.au>

1 files changed, 13 insertions, 9 deletions

diff --git a/include/avirt/avirt.h b/include/avirt/avirt.h
index e8b236a..0fd116e 100644
--- a/include/avirt/avirt.h
+++ b/include/avirt/avirt.h
@@ -27,26 +27,30 @@
  * snd_avirt_stream_new - Create a stream in AVIRT
  * @name: The name of the stream
  * @channels: The number of channels for the stream
- * @direction: The stream direction (SND_PCM_STREAM_PLAYBACK or SND_PCM_STREAM_CAPTURE)
+ * @direction: The stream direction
+ *             (SND_PCM_STREAM_PLAYBACK or SND_PCM_STREAM_CAPTURE)
  * @map: The audio path to map this stream to
  * @return: 0 on success, negative ERRNO otherwise
  * 
  * Each stream creates a PCM device for the AVIRT sound card.
- * Streams will not appear to the user-space until `snd_avirt_card_seal()` is called.
- * NOTE: Once `snd_avirt_card_seal` is called, no more streams may be added.
+ * Streams will not appear to the user-space until `snd_avirt_card_seal()`
+ * is called.
+ * 
+ * NOTE: Once this function is called, no more streams may be added.
  */
 int snd_avirt_stream_new(const char *name, unsigned int channels, int direction,
-                       const char *map);
+                         const char *map);
 
 /**
  * snd_avirt_card_seal - Finalize AVIRT stream creation and register sound card
  * @return: 0 on success, negative ERRNO otherwise
  * 
- * This should be called once all streams have been created via `snd_avirt_stream_new()`.
- * Calling this function will register the AVIRT sound card to the user-space, and will
- * configure all mapped lower-level Audio Paths for the given stream configuration.
- * configuration.
- * Once this function is called, no more streams may be created.
+ * This should be called once all streams have been created via
+ * `snd_avirt_stream_new()`. Calling this function will register the AVIRT
+ * sound card to the user-space, and will configure all mapped lower-level
+ * Audio Paths for the given stream configuration.
+ * 
+ * NOTE: Once this function is called, no more streams may be added.
  */
 int snd_avirt_card_seal();