chiark / gitweb /
doxygen: add some missing docstrings.
authorRichard Kettlewell <rjk@terraraq.org.uk>
Sun, 7 Aug 2011 16:00:09 +0000 (17:00 +0100)
committerRichard Kettlewell <rjk@terraraq.org.uk>
Sun, 7 Aug 2011 16:00:09 +0000 (17:00 +0100)
clients/resample.c
lib/strptime.c
lib/strptime.h
lib/validity.h
plugins/tracklength.h
server/decode-flac.c
server/decode-ogg.c
server/decode-wav.c

index bc41013..6291c83 100644 (file)
@@ -15,6 +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 clients/resample.c
+ * @brief Audio resampler
+ */
 #include "common.h"
 
 #include <unistd.h>
index 91d57d5..27ef40a 100644 (file)
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  */
-
-/* strptime() is here reimplemented because the FreeBSD (and older MacOS) one
+/** @file lib/strptime.c
+ * @brief strptime() reimplementation
+ *
+ * strptime() is here reimplemented because the FreeBSD (and older MacOS) one
  * is broken and does not report errors properly.  See TODO remarks below for
- * some missing bits. */
+ * some missing bits.
+ */
 
 #include <ctype.h>
 #include <limits.h>
index 324f88d..b2b3715 100644 (file)
@@ -1,5 +1,8 @@
 #ifndef STRPTIME_H
 #define STRPTIME_H
+/** @file lib/strptime.h
+ * @brief strptime() reimplementation
+ */
 
 #include <time.h>
 
index 8ce2505..6254708 100644 (file)
@@ -17,7 +17,7 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
-/** @file lib/validity.c
+/** @file lib/validity.h
  * @brief Various validity checks
  */
 #ifndef VALIDITY_H
index c8e22a4..112b652 100644 (file)
@@ -15,6 +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 plugins/tracklength.h
+ * @brief Plugin to compute track lengths
+ */
 
 #ifndef TRACKLENGTH_H
 #define TRACKLENGTH_H
index f1399fb..9577d9d 100644 (file)
@@ -15,7 +15,7 @@
  * 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 server/decode.c
+/** @file server/decode-flac.c
  * @brief General-purpose decoder for use by speaker process
  */
 #include "decode.h"
index d499955..efa10a7 100644 (file)
@@ -15,7 +15,7 @@
  * 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 server/decode.c
+/** @file server/decode-ogg.c
  * @brief General-purpose decoder for use by speaker process
  */
 #include "decode.h"
index fd58a14..8fdc10e 100644 (file)
@@ -15,7 +15,7 @@
  * 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 server/decode.c
+/** @file server/decode-wav.c
  * @brief General-purpose decoder for use by speaker process
  */
 #include "decode.h"