ArchiveLookup: move API documentation to header

src/ArchiveLookup.cxx

@@ -29,24 +29,6 @@
 #include <unistd.h>
 #include <errno.h>
 
-/**
- *
- * archive_lookup is used to determine if part of pathname refers to an regular
- * file (archive). If so then its also used to split pathname into archive file
- * and path used to locate file in archive. It also returns suffix of the file.
- * How it works:
- * We do stat of the parent of input pathname as long as we find an regular file
- * Normally this should never happen. When routine returns true pathname modified
- * and split into archive, inpath and suffix. Otherwise nothing happens
- *
- * For example:
- *
- * /music/path/Talco.zip/Talco - Combat Circus/12 - A la pachenka.mp3
- * is split into archive:	/music/path/Talco.zip
- * inarchive pathname:		Talco - Combat Circus/12 - A la pachenka.mp3
- * and suffix:			 zip
- */
-
 bool archive_lookup(char *pathname, char **archive, char **inpath, char **suffix)
 {
 	char *pathdupe;

src/ArchiveLookup.hxx

@@ -20,12 +20,23 @@
 #ifndef MPD_ARCHIVE_LOOKUP_HXX
 #define MPD_ARCHIVE_LOOKUP_HXX
 
-/*
- * This is the public API which is used by archive plugins to
- * provide transparent archive decompression layer for mpd
+/**
+ *
+ * archive_lookup is used to determine if part of pathname refers to an regular
+ * file (archive). If so then its also used to split pathname into archive file
+ * and path used to locate file in archive. It also returns suffix of the file.
+ * How it works:
+ * We do stat of the parent of input pathname as long as we find an regular file
+ * Normally this should never happen. When routine returns true pathname modified
+ * and split into archive, inpath and suffix. Otherwise nothing happens
  *
+ * For example:
+ *
+ * /music/path/Talco.zip/Talco - Combat Circus/12 - A la pachenka.mp3
+ * is split into archive:	/music/path/Talco.zip
+ * inarchive pathname:		Talco - Combat Circus/12 - A la pachenka.mp3
+ * and suffix:			 zip
  */
-
 bool archive_lookup(char *pathname, char **archive, char **inpath, char **suffix);
 
 #endif