Replace all 'TODO:' with '\todo' docbook, adding \file comments if needed.

10 files changed, 35 insertions, 50 deletions

diff --git a/src/buf.c b/src/buf.c
index 0e9efa5..54f2edf 100644
--- a/src/buf.c
+++ b/src/buf.c
@@ -30,11 +30,11 @@
  * refilled from appropriate input and output FILEs.  A dynamically
  * allocated buffer of configurable size is used as an intermediary.
  *
- * TODO: Perhaps be more efficient by filling the buffer on every call
+ * \todo Perhaps be more efficient by filling the buffer on every call
  * even if not yet completely empty.  Check that it's really our
  * buffer, and shuffle remaining data down to the front.
  *
- * TODO: Perhaps expose a routine for shuffling the buffers.
+ * \todo Perhaps expose a routine for shuffling the buffers.
  */
 
 
diff --git a/src/emit.c b/src/emit.c
index 228e5cb..49859a5 100644
--- a/src/emit.c
+++ b/src/emit.c
@@ -19,17 +19,12 @@
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
 
-
-/*
- * TODO: Pluggable encoding formats:
+/** \file emit.c encoding output routines.
  *
- *  - gdiff-style
- *  - rsync 24
- *  - ed (text)
- *  - Delta HTTP
+ * \todo Pluggable encoding formats: gdiff-style, rsync 24, ed (text),
+ * Delta HTTP.
  */
 
-
 #include "config.h"
 
 #include <assert.h>
@@ -46,9 +41,7 @@
 #include "job.h"
 
 
-/**
- * Write the magic for the start of a delta.
- */
+/** Write the magic for the start of a delta. */
 void
 rs_emit_delta_header(rs_job_t *job)
 {
@@ -129,7 +122,7 @@ rs_emit_copy_cmd(rs_job_t *job, rs_long_t where, rs_long_t len)
     stats->copy_bytes += len;
     stats->copy_cmdbytes += 1 + where_bytes + len_bytes;
 
-    /* TODO: All the stats */
+    /* \todo All the stats */
 }
 
 
diff --git a/src/mdfour.c b/src/mdfour.c
index 2974686..986bbc0 100644
--- a/src/mdfour.c
+++ b/src/mdfour.c
@@ -21,9 +21,9 @@
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
 
-/* MD4 message digest algorithm.
+/** \file mdfour.c MD4 message digest algorithm.
  *
- * TODO: Perhaps use the MD4 routine from OpenSSL if it's installed.
+ * \todo Perhaps use the MD4 routine from OpenSSL if it's installed.
  * It's probably not worth the trouble.
  *
  * This was originally written by Andrew Tridgell for use in Samba.
diff --git a/src/mksum.c b/src/mksum.c
index fffaf22..c95e44e 100644
--- a/src/mksum.c
+++ b/src/mksum.c
@@ -28,9 +28,8 @@
  * process whatever data is available.  When a whole block has
  * arrived, or we've reached the end of the file, we write the
  * checksum out.
- */
-
-/* TODO: Perhaps force blocks to be a multiple of 64 bytes, so that we
+ *
+ * \todo Perhaps force blocks to be a multiple of 64 bytes, so that we
  * can be sure checksum generation will be more efficient.  I guess it
  * will be OK at the moment, though, because tails are only used if
  * necessary. */
diff --git a/src/msg.c b/src/msg.c
index 1f9aa05..c2f6b65 100644
--- a/src/msg.c
+++ b/src/msg.c
@@ -19,7 +19,6 @@
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
 
-
                               /*=
                                | Welcome to Arco AM/PM Mini-Market. We
                                | would like to advise our customers
@@ -34,6 +33,13 @@
                                | Arco, and have a nice day.
                                */
 
+/** \file msg.c error messages for re_result values.
+ *
+ * \todo (Suggestion by tridge) Add a function which outputs a
+ * complete text description of a job, including only the fields
+ * relevant to the current encoding function.
+ */
+
 #include "config.h"
 
 #include <stdlib.h>
@@ -41,13 +47,6 @@
 
 #include "librsync.h"
 
-/*
- * TODO: (Suggestion by tridge) Add a function which outputs a
- * complete text description of a job, including only the fields
- * relevant to the current encoding function.
- */
-
-
 char const *rs_strerror(rs_result r)
 {
     switch (r) {
diff --git a/src/netint.c b/src/netint.c
index 116eb93..04a9d0b 100644
--- a/src/netint.c
+++ b/src/netint.c
@@ -37,7 +37,7 @@
  * since we don't want to rely on stdint types that may not be
  * available on some platforms.
  *
- * TODO: If we don't have <stdint.h> (or perhaps even if we do),
+ * \todo If we don't have <stdint.h> (or perhaps even if we do),
  * determine endianness and integer size by hand and use that to do
  * our own conversion routines.  We possibly need this anyhow to do
  * 64-bit integers, since there seems to be no ntohs() analog.
diff --git a/src/rdiff.c b/src/rdiff.c
index c9d4541..40fe233 100644
--- a/src/rdiff.c
+++ b/src/rdiff.c
@@ -28,19 +28,19 @@
 
 /** \file rdiff.c -- Command-line network-delta tool.
  *
- * TODO: Add a -z option to gzip/gunzip patches.  This would be
+ * \todo Add a -z option to gzip/gunzip patches.  This would be
  * somewhat useful, but more importantly a good test of the streaming
  * API.  Also add -I for bzip2.
  *
- * If built with debug support and we have mcheck, then turn it on.
+ * \todo If built with debug support and we have mcheck, then turn it on.
  * (Optionally?)
  *
- * FIXME: popt doesn't handle single dashes very well at the moment:
+ * \todo popt doesn't handle single dashes very well at the moment:
  * we'd like to use them as arguments to indicate stdin/stdout, but it
  * turns them into options.  I sent a patch to the popt maintainers;
  * hopefully it will be fixed in the future.
  *
- * TODO: Add an option for delta to check whether the files are
+ * \todo Add an option for delta to check whether the files are
  * identical.
  */
 
diff --git a/src/scoop.c b/src/scoop.c
index 1b8f14e..5c19ee5 100644
--- a/src/scoop.c
+++ b/src/scoop.c
@@ -19,6 +19,12 @@
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
 
+                              /*=
+                               | To walk on water you've gotta sink
+                               | in the ice.
+                               |   -- Shihad, `The General Electric'.
+                               */
+
 /** \file scoop.c This file deals with readahead from caller-supplied
  * buffers.
  *
@@ -40,7 +46,7 @@
  * As a future optimization, we might try to take data directly from the
  * input buffer if there's already enough there.
  *
- * TODO: We probably know a maximum amount of data that can be scooped
+ * \todo We probably know a maximum amount of data that can be scooped
  * up, so we could just avoid dynamic allocation.  However that can't
  * be fixed at compile time, because when generating a delta it needs
  * to be large enough to hold one full block.  Perhaps we can set it
@@ -48,12 +54,6 @@
  * any memory allocation after startup, as bzlib does this.
  */
 
-                              /*=
-                               | To walk on water you've gotta sink
-                               | in the ice.
-                               |   -- Shihad, `The General Electric'.
-                               */
-
 #include "config.h"
 
 #include <assert.h>
diff --git a/src/stats.c b/src/stats.c
index 9943a56..f554f18 100644
--- a/src/stats.c
+++ b/src/stats.c
@@ -17,6 +17,10 @@
  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  */
 
+/** \file stats.c stats reporting functions.
+ *
+ * \todo Other things to show in statistics: number of input and output bytes,
+ * number of times we blocked waiting for input or output, number of blocks. */
 
 #include "config.h"
 
@@ -33,16 +37,6 @@
 #include "librsync.h"
 #include "trace.h"
 
-/*
- * TODO: Other things to show in statistics:
- *
- * Number of input and output bytes.
- *
- * Number of times we blocked waiting for input or output.
- *
- * Number of blocks.
- */
-
 int
 rs_log_stats(rs_stats_t const *stats)
 {
diff --git a/src/stream.c b/src/stream.c
index 14eb2b8..7e780b3 100644
--- a/src/stream.c
+++ b/src/stream.c
@@ -77,7 +77,7 @@
  * flush output.  This may well use up all the remaining stream space,
  * in which case nothing else can be done.
  *
- * TODO: Kill this file and move the vestigial code remaining closer to where
+ * \todo Kill this file and move the vestigial code remaining closer to where
  * it's used.  */
 
 #include "config.h"