disorder.h: more consistent approach to function attributes

[disorder] / lib / trackname.h

diff --git a/lib/trackname.h b/lib/trackname.h
index 31c7df8eb4899d3431768fd0b418b26ce26f552e..56f933ee95682d21911e856f2d3255b7018585b7 100644 (file)
--- a/lib/trackname.h
+++ b/lib/trackname.h
@@ -15,7 +15,9 @@
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
-
+/** @file lib/trackname.h
+ * @brief Track name calculation
+ */
 #ifndef TRACKNAME_H
 #define TRACKNAME_H
 
@@ -49,7 +51,14 @@ int compare_path_raw(const unsigned char *ap, size_t an,
 /* Comparison function for path names that groups all entries in a directory
  * together */
 
-/* Convenient wrapper for compare_path_raw */
+/** @brief Compare two paths
+ * @param ap First path
+ * @param bp Second path
+ * @return -ve, 0 or +ve for ap <, = or > bp
+ *
+ * Sorts files within a directory together.
+ * A wrapper around compare_path_raw().
+ */
 static inline int compare_path(const char *ap, const char *bp) {
   return compare_path_raw((const unsigned char *)ap, strlen(ap),
                          (const unsigned char *)bp, strlen(bp));