From: Richard Kettlewell <rjk@terraraq.org.uk>
Date: Sun, 7 Aug 2011 16:00:09 +0000 (+0100)
Subject: doxygen: add some missing docstrings.
X-Git-Tag: branchpoint-5.1~23
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/commitdiff_plain/1a164e639307f5050638cc01ead9d4657e26e7a5

doxygen: add some missing docstrings.
---

diff --git a/clients/resample.c b/clients/resample.c
index bc41013..6291c83 100644
--- a/clients/resample.c
+++ b/clients/resample.c
@@ -15,6 +15,9 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+/** @file clients/resample.c
+ * @brief Audio resampler
+ */
 #include "common.h"
 
 #include <unistd.h>
diff --git a/lib/strptime.c b/lib/strptime.c
index 91d57d5..27ef40a 100644
--- a/lib/strptime.c
+++ b/lib/strptime.c
@@ -26,10 +26,13 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  */
-
-/* strptime() is here reimplemented because the FreeBSD (and older MacOS) one
+/** @file lib/strptime.c
+ * @brief strptime() reimplementation
+ *
+ * strptime() is here reimplemented because the FreeBSD (and older MacOS) one
  * is broken and does not report errors properly.  See TODO remarks below for
- * some missing bits. */
+ * some missing bits.
+ */
 
 #include <ctype.h>
 #include <limits.h>
diff --git a/lib/strptime.h b/lib/strptime.h
index 324f88d..b2b3715 100644
--- a/lib/strptime.h
+++ b/lib/strptime.h
@@ -1,5 +1,8 @@
 #ifndef STRPTIME_H
 #define STRPTIME_H
+/** @file lib/strptime.h
+ * @brief strptime() reimplementation
+ */
 
 #include <time.h>
 
diff --git a/lib/validity.h b/lib/validity.h
index 8ce2505..6254708 100644
--- a/lib/validity.h
+++ b/lib/validity.h
@@ -17,7 +17,7 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
-/** @file lib/validity.c
+/** @file lib/validity.h
  * @brief Various validity checks
  */
 #ifndef VALIDITY_H
diff --git a/plugins/tracklength.h b/plugins/tracklength.h
index c8e22a4..112b652 100644
--- a/plugins/tracklength.h
+++ b/plugins/tracklength.h
@@ -15,6 +15,9 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
+/** @file plugins/tracklength.h
+ * @brief Plugin to compute track lengths
+ */
 
 #ifndef TRACKLENGTH_H
 #define TRACKLENGTH_H
diff --git a/server/decode-flac.c b/server/decode-flac.c
index f1399fb..9577d9d 100644
--- a/server/decode-flac.c
+++ b/server/decode-flac.c
@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-/** @file server/decode.c
+/** @file server/decode-flac.c
  * @brief General-purpose decoder for use by speaker process
  */
 #include "decode.h"
diff --git a/server/decode-ogg.c b/server/decode-ogg.c
index d499955..efa10a7 100644
--- a/server/decode-ogg.c
+++ b/server/decode-ogg.c
@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-/** @file server/decode.c
+/** @file server/decode-ogg.c
  * @brief General-purpose decoder for use by speaker process
  */
 #include "decode.h"
diff --git a/server/decode-wav.c b/server/decode-wav.c
index fd58a14..8fdc10e 100644
--- a/server/decode-wav.c
+++ b/server/decode-wav.c
@@ -15,7 +15,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-/** @file server/decode.c
+/** @file server/decode-wav.c
  * @brief General-purpose decoder for use by speaker process
  */
 #include "decode.h"