add doxygen file comments
authorAndre <maan@p133.(none)>
Thu, 20 Apr 2006 14:24:56 +0000 (16:24 +0200)
committerAndre <maan@p133.(none)>
Thu, 20 Apr 2006 14:24:56 +0000 (16:24 +0200)
modified: alsa_writer.c write.h write_common.c write_common.h

alsa_writer.c
write.h
write_common.c
write_common.h

index b0bc3b0..6a3d18a 100644 (file)
@@ -16,6 +16,8 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file alsa_writer.c Data specific to the alsa writer */
+
 /*
  * Based in parts on aplay.c from the alsa-utils-1.0.8 package,
  * Copyright (c) by Jaroslav Kysela <perex@suse.cz>, which is
diff --git a/write.h b/write.h
index 3ef691a..102f1b2 100644 (file)
--- a/write.h
+++ b/write.h
@@ -16,6 +16,8 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file write.h writer-related structures */
+
 enum writer_enum {WRITER_ENUM};
 
 struct writer_node {
index a7896fc..e496c26 100644 (file)
@@ -16,6 +16,8 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file write_common.c common functions of para_audiod and para_write */
+
 #include "para.h"
 #include "string.h"
 #include "write.h"
index e7652e2..0eb2ae7 100644 (file)
@@ -16,6 +16,8 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file write_common.h exported symbols from write_common.c */
+
 int wng_write(struct writer_node_group *g, char *buf, size_t *loaded);
 int wng_open(struct writer_node_group *g);
 void wng_close(struct writer_node_group *g);