X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=aft.c;h=c99b5ac52dc5f336d85d6a311fd80b0cd2f3ad9f;hp=5c1605207f67cb114b7e7d6d4add234824bc3af5;hb=33cd9d752860f24d887d8fb9abfd103ca4297148;hpb=1f31b52b6816ce2716a3755a1896f77744fa167b

diff --git a/aft.c b/aft.c
index 5c160520..c99b5ac5 100644
--- a/aft.c
+++ b/aft.c
@@ -1221,12 +1221,8 @@ out:
 }
 
 /*
- * TODO: flags -h (sort by hash) -lm (list in mbox format)
- *
- * long list: list hash, attributes as (xx--x-x-), file size, lastplayed
- * full list: list everything, including afsi, afhi, atts as clear text
- *
- * */
+ * TODO: flags -h (sort by hash)
+ */
 int com_ls(int fd, int argc, char * const * const argv)
 {
 	int i, ret;
@@ -1793,16 +1789,25 @@ enum touch_flags {
 	TOUCH_FLAG_VERBOSE = 2
 };
 
+/** Options used by com_touch(). */
 struct com_touch_options {
+	/** New num_played value. */
 	int32_t num_played;
+	/** New last played count. */
 	int64_t last_played;
+	/** new lyrics id. */
 	int32_t lyrics_id;
+	/** new image id. */
 	int32_t image_id;
+	/** command line flags (see \ref touch_flags). */
 	unsigned flags;
 };
 
+/** Data passed to the action handler of com_touch(). */
 struct touch_action_data {
+	/** Command line options (see \ref com_touch_options). */
 	struct com_touch_options *cto;
+	/** Message buffer. */
 	struct para_buffer pb;
 };
 
@@ -1947,22 +1952,30 @@ int com_touch(int fd, int argc, char * const * const argv)
 	return ret;
 }
 
+/** Flags for com_rm(). */
 enum rm_flags {
+	/** -v */
 	RM_FLAG_VERBOSE = 1,
+	/** -f */
 	RM_FLAG_FORCE = 2,
+	/** -p */
 	RM_FLAG_FNM_PATHNAME = 4
 };
 
-struct com_rm_data {
+/** Data passed to the action handler of com_rm(). */
+struct com_rm_action_data {
+	/** Command line flags ((see \ref rm_flags). */
 	uint32_t flags;
+	/** Message buffer. */
 	struct para_buffer pb;
+	/** Number of audio files removed. */
 	unsigned num_removed;
 };
 
 static int remove_audio_file(__a_unused struct osl_table *table,
 		struct osl_row *row, const char *name, void *data)
 {
-	struct com_rm_data *crd = data;
+	struct com_rm_action_data *crd = data;
 	int ret;
 
 	if (crd->flags & RM_FLAG_VERBOSE)
@@ -1979,7 +1992,7 @@ static int remove_audio_file(__a_unused struct osl_table *table,
 static int com_rm_callback(const struct osl_object *query,
 		__a_unused struct osl_object *result)
 {
-	struct com_rm_data crd = {.flags = *(uint32_t *)query->data};
+	struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data};
 	int ret;
 	struct pattern_match_data pmd = {
 		.table = audio_file_table,
@@ -2071,10 +2084,15 @@ enum cpsi_flags {
 	CPSI_FLAG_VERBOSE = 32,
 };
 
+/** Data passed to the action handler of com_cpsi(). */
 struct cpsi_action_data {
+	/** command line flags (see \ref cpsi_flags). */
 	unsigned flags;
+	/** Number of audio files changed. */
 	unsigned num_copied;
+	/** Message buffer. */
 	struct para_buffer pb;
+	/** Values are copied from here. */
 	struct afs_info source_afsi;
 };