summaryrefslogtreecommitdiff
path: root/src/job.c
diff options
context:
space:
mode:
authorDonovan Baarda <abo@minkirri.apana.org.au>2021-08-24 20:58:48 +1000
committerDonovan Baarda <abo@minkirri.apana.org.au>2021-08-24 20:58:48 +1000
commit45adadf6045e8749799cbbe55a4eda6d9c9e00c0 (patch)
tree65cee7c13b67ea08ecf9c03b4ad05f374182a374 /src/job.c
parentbd53f9e6f04f14e1e6d4207fc88a2a776120fd9d (diff)
downloadlibrsync-45adadf6045e8749799cbbe55a4eda6d9c9e00c0.tar.gz
Add doxygen `\file` docs to all headers and state engine files.
Move doxygen docs from `*.c` files to their corresponding `*.h` files if there is one. Remove any "private" or "internal" markers from docs. It's already clear the librsync.h is the only public interface, but the rest of the docs are useful for understanding the code so we still want to generate them.
Diffstat (limited to 'src/job.c')
-rw-r--r--src/job.c8
1 files changed, 0 insertions, 8 deletions
diff --git a/src/job.c b/src/job.c
index 41afd22..84b72f4 100644
--- a/src/job.c
+++ b/src/job.c
@@ -25,14 +25,6 @@
| sheltering.
*/
-/** \file job.c
- * Generic state-machine interface.
- *
- * The point of this is that we need to be able to suspend and resume
- * processing at any point at which the buffers may block.
- *
- * \sa \ref api_streaming \sa rs_job_iter() \sa ::rs_job */
-
#include <assert.h>
#include <stdlib.h>
#include <time.h>