Documentation update by Clement Ladish

1 files changed, 24 insertions, 8 deletions

diff --git a/include/input.h b/include/input.h
index 8d0c5cf8..105b1288 100644
--- a/include/input.h
+++ b/include/input.h
@@ -7,8 +7,8 @@
  * \date 1998-2001
  *
  * Application interface library for the ALSA driver
- *
- *
+ */
+/*
  *   This library is free software; you can redistribute it and/or modify
  *   it under the terms of the GNU Lesser General Public License as
  *   published by the Free Software Foundation; either version 2.1 of
@@ -34,18 +34,30 @@ extern "C" {
 
 /**
  *  \defgroup Input Input Interface
- *  Input Interface
+ *
+ *  The input functions present an interface similar to the stdio functions
+ *  on top of different underlying input sources.
+ *
+ *  The #snd_config_load function uses such an input handle to be able to
+ *  load configurations not only from standard files but also from other
+ *  sources, e.g. from memory buffers.
+ *
  *  \{
  */
 
-/** Input handle */
+/**
+ * \brief Internal structure for an input object.
+ *
+ * The ALSA library uses a pointer to this structure as a handle to an
+ * input object. Applications don't access its contents directly.
+ */
 typedef struct _snd_input snd_input_t;
 
-/** Input type */
+/** Input type. */
 typedef enum _snd_input_type {
-	/** Input from a stdio stream */
+	/** Input from a stdio stream. */
 	SND_INPUT_STDIO,
-	/** Input from a memory buffer */
+	/** Input from a memory buffer. */
 	SND_INPUT_BUFFER
 } snd_input_type_t;
 
@@ -53,7 +65,11 @@ int snd_input_stdio_open(snd_input_t **inputp, const char *file, const char *mod
 int snd_input_stdio_attach(snd_input_t **inputp, FILE *fp, int _close);
 int snd_input_buffer_open(snd_input_t **inputp, const char *buffer, ssize_t size);
 int snd_input_close(snd_input_t *input);
-int snd_input_scanf(snd_input_t *input, const char *format, ...) __attribute__ ((format (scanf, 2, 3)));
+int snd_input_scanf(snd_input_t *input, const char *format, ...)
+#ifndef DOC_HIDDEN
+	__attribute__ ((format (scanf, 2, 3)))
+#endif
+	;
 char *snd_input_gets(snd_input_t *input, char *str, size_t size);
 int snd_input_getc(snd_input_t *input);
 int snd_input_ungetc(snd_input_t *input, int c);