From: Andre <maan@p133.(none)>
Date: Thu, 20 Apr 2006 14:24:56 +0000 (+0200)
Subject: add doxygen file comments
X-Git-Tag: v0.2.12~42
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=24495e62d3896d98d6c27f9665edfe6492ddd757;p=paraslash.git

add doxygen file comments

modified: alsa_writer.c write.h write_common.c write_common.h
---

diff --git a/alsa_writer.c b/alsa_writer.c
index b0bc3b09..6a3d18a3 100644
--- a/alsa_writer.c
+++ b/alsa_writer.c
@@ -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 3ef691a3..102f1b25 100644
--- 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 {
diff --git a/write_common.c b/write_common.c
index a7896fcb..e496c26c 100644
--- a/write_common.c
+++ b/write_common.c
@@ -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"
diff --git a/write_common.h b/write_common.h
index e7652e20..0eb2ae71 100644
--- a/write_common.h
+++ b/write_common.h
@@ -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);