X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/52a3ff02366002595d19efd9f5e29fc523ae7d2c..d53ef367fb4f4aed2e2ff9d8ef4c187a61c9497e:/lib/tracksort.c?ds=sidebyside

diff --git a/lib/tracksort.c b/lib/tracksort.c
index 2f81739..b1fcc3a 100644
--- a/lib/tracksort.c
+++ b/lib/tracksort.c
@@ -32,6 +32,16 @@ static int tracksort_compare(const void *a, const void *b) {
 			ea->track, eb->track);
 }
 
+/** @brief Sort tracks
+ * @param ntracks Number of tracks to sort
+ * @param tracks List of tracks
+ * @param type Comparison type
+ * @return Sorted track data
+ *
+ * Tracks are compared using compare_tracks(), with the sort key and display
+ * string set according to @p type, which should be "track" if the tracks are
+ * really tracks and "dir" if they are directories.
+ */
 struct tracksort_data *tracksort_init(int ntracks,
                                       char **tracks,
                                       const char *type) {