From d9660cee96f1c1b1ae0bf1be432ac1e189b59dd2 Mon Sep 17 00:00:00 2001
From: Andre Noll <maan@tuebingen.mpg.de>
Date: Sat, 8 Sep 2018 15:29:44 +0200
Subject: [PATCH] aft: Consolidate comments for sorting/listing enums.

This saves a couple of lines and improves readability.

The patch also changes the format of the doxygen comments from -sX
to -s=X and similar for -l, as this has become the required syntax
for -s, and is preferred (albeit not required) also for -l.
---
 aft.c | 54 ++++++++++++++++++------------------------------------
 1 file changed, 18 insertions(+), 36 deletions(-)

diff --git a/aft.c b/aft.c
index b6ea0257..0db2c580 100644
--- a/aft.c
+++ b/aft.c
@@ -50,46 +50,28 @@ static struct ls_data status_item_ls_data;
 
 /** The different sorting methods of the ls command. */
 enum ls_sorting_method {
-	/** -sp (default) */
-	LS_SORT_BY_PATH,
-	/** -ss */
-	LS_SORT_BY_SCORE,
-	/** -sl */
-	LS_SORT_BY_LAST_PLAYED,
-	/** -sn */
-	LS_SORT_BY_NUM_PLAYED,
-	/** -sf */
-	LS_SORT_BY_FREQUENCY,
-	/** -sc */
-	LS_SORT_BY_CHANNELS,
-	/** -si */
-	LS_SORT_BY_IMAGE_ID,
-	/** -sy */
-	LS_SORT_BY_LYRICS_ID,
-	/** -sb */
-	LS_SORT_BY_BITRATE,
-	/** -sd */
-	LS_SORT_BY_DURATION,
-	/** -sa */
-	LS_SORT_BY_AUDIO_FORMAT,
-	/** -sh */
-	LS_SORT_BY_HASH,
+	LS_SORT_BY_PATH, /**< -s=p (default) */
+	LS_SORT_BY_SCORE, /**< -s=s */
+	LS_SORT_BY_LAST_PLAYED, /**< -s=l */
+	LS_SORT_BY_NUM_PLAYED, /**< -s=n */
+	LS_SORT_BY_FREQUENCY, /**< -s=f */
+	LS_SORT_BY_CHANNELS, /**< -s=c */
+	LS_SORT_BY_IMAGE_ID, /**< -s=i */
+	LS_SORT_BY_LYRICS_ID, /**< -s=y */
+	LS_SORT_BY_BITRATE, /**< -s=b */
+	LS_SORT_BY_DURATION, /**< -s=d */
+	LS_SORT_BY_AUDIO_FORMAT, /**< -s=a */
+	LS_SORT_BY_HASH, /**< -s=h */
 };
 
 /** The different listing modes of the ls command. */
 enum ls_listing_mode {
-	/** Default listing mode. */
-	LS_MODE_SHORT,
-	/** -l or -ll */
-	LS_MODE_LONG,
-	/** -lv */
-	LS_MODE_VERBOSE,
-	/** -lm */
-	LS_MODE_MBOX,
-	/** -lc */
-	LS_MODE_CHUNKS,
-	/** -lp */
-	LS_MODE_PARSER,
+	LS_MODE_SHORT, /**< Default listing mode. */
+	LS_MODE_LONG, /**< -l or -l=l */
+	LS_MODE_VERBOSE, /** -l=v */
+	LS_MODE_MBOX, /** -l=m */
+	LS_MODE_CHUNKS, /** -l=c */
+	LS_MODE_PARSER, /** -l=p */
 };
 
 /**
-- 
2.39.5