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 b0bc3b095826924fe799da12c0bc79a8b0241cba..6a3d18a33464e3fe652afeadeae9e47579d92dae 100644 (file)
--- 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 3ef691a3a65b884a329f1119065e05e1a96a554f..102f1b25cb3c4bdaea12d0820e0e3b4af4175db8 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 {

diff --git a/write_common.c b/write_common.c
index a7896fcb4ebd039e7401671c232ad2198bad8917..e496c26ca7c547fe185e5f7df1156c230bcaaec1 100644 (file)
--- 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 e7652e20c8dbd3ea30bff3aad13604f33830aa62..0eb2ae715652af243dc3f02b200d3e27012fd3b7 100644 (file)
--- 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);