doxygen: do not include license boilerplate in Doxygen documentation

2011-07-14 03:11:19 +02:00 · 2011-07-14 03:11:19 +02:00 · 6168781f70
parent ca5d57ef8a
commit 6168781f70
20 changed files with 115 additions and 75 deletions
--- a/libavcodec/huffman.c
+++ b/libavcodec/huffman.c
@ -1,6 +1,4 @@
-/**
- * @file
- * huffman tree builder and VLC generator
+/*
 * Copyright (c) 2006 Konstantin Shishkov
 *
 * This file is part of Libav.
@ -20,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * huffman tree builder and VLC generator
+ */
+
 #include "avcodec.h"
 #include "get_bits.h"
 #include "huffman.h"
--- a/libavcodec/huffman.h
+++ b/libavcodec/huffman.h
@ -1,6 +1,4 @@
-/**
- * @file
- * huffman tree builder and VLC generator
+/*
 * Copyright (C) 2007  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -20,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * huffman tree builder and VLC generator
+ */
+
 #ifndef AVCODEC_HUFFMAN_H
 #define AVCODEC_HUFFMAN_H

--- a/libavcodec/vorbis.c
+++ b/libavcodec/vorbis.c
@ -1,8 +1,4 @@
-/**
- * @file
- * Common code for Vorbis I encoder and decoder
- * @author Denes Balatoni  ( dbalatoni programozo hu )
- *
+/*
 * This file is part of Libav.
 *
 * Libav is free software; you can redistribute it and/or
@ -20,6 +16,12 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * Common code for Vorbis I encoder and decoder
+ * @author Denes Balatoni  ( dbalatoni programozo hu )
+ */
+
 #define ALT_BITSTREAM_READER_LE
 #include "avcodec.h"
 #include "get_bits.h"
--- a/libavcodec/vorbisdec.c
+++ b/libavcodec/vorbisdec.c
@ -1,8 +1,4 @@
-/**
- * @file
- * Vorbis I decoder
- * @author Denes Balatoni  ( dbalatoni programozo hu )
- *
+/*
 * This file is part of Libav.
 *
 * Libav is free software; you can redistribute it and/or
@ -20,6 +16,12 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * Vorbis I decoder
+ * @author Denes Balatoni  ( dbalatoni programozo hu )
+ */
+
 #include <inttypes.h>
 #include <math.h>

--- a/libavcodec/vp5.c
+++ b/libavcodec/vp5.c
@ -1,7 +1,4 @@
-/**
- * @file
- * VP5 compatible video decoder
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP5 compatible video decoder
+ */
+
 #include <stdlib.h>
 #include <string.h>

--- a/libavcodec/vp56.c
+++ b/libavcodec/vp56.c
@ -1,7 +1,4 @@
-/**
- * @file
- * VP5 and VP6 compatible video decoder (common features)
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP5 and VP6 compatible video decoder (common features)
+ */
+
 #include "avcodec.h"
 #include "bytestream.h"

--- a/libavcodec/vp56.h
+++ b/libavcodec/vp56.h
@ -1,7 +1,4 @@
-/**
- * @file
- * VP5 and VP6 compatible video decoder (common features)
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP5 and VP6 compatible video decoder (common features)
+ */
+
 #ifndef AVCODEC_VP56_H
 #define AVCODEC_VP56_H

--- a/libavcodec/vp56data.c
+++ b/libavcodec/vp56data.c
@ -1,7 +1,4 @@
-/**
- * @file
- * VP5 and VP6 compatible video decoder (common data)
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP5 and VP6 compatible video decoder (common data)
+ */
+
 #include "vp56data.h"

 const uint8_t vp56_b2p[]   = { 0, 0, 0, 0, 1, 2, 3, 3, 3, 3 };
--- a/libavcodec/vp56data.h
+++ b/libavcodec/vp56data.h
@ -1,7 +1,4 @@
-/**
- * @file
- * VP5 and VP6 compatible video decoder (common data)
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP5 and VP6 compatible video decoder (common data)
+ */
+
 #ifndef AVCODEC_VP56DATA_H
 #define AVCODEC_VP56DATA_H

--- a/libavcodec/vp5data.h
+++ b/libavcodec/vp5data.h
@ -1,7 +1,4 @@
-/**
- * @file
- * VP5 compatible video decoder
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP5 compatible video decoder
+ */
+
 #ifndef AVCODEC_VP5DATA_H
 #define AVCODEC_VP5DATA_H

--- a/libavcodec/vp6.c
+++ b/libavcodec/vp6.c
@ -1,13 +1,6 @@
-/**
- * @file
- * VP6 compatible video decoder
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
- * The VP6F decoder accepts an optional 1 byte extradata. It is composed of:
- *  - upper 4bits: difference between encoded width and visible width
- *  - lower 4bits: difference between encoded height and visible height
- *
 * This file is part of Libav.
 *
 * Libav is free software; you can redistribute it and/or
@ -25,6 +18,15 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP6 compatible video decoder
+ *
+ * The VP6F decoder accepts an optional 1 byte extradata. It is composed of:
+ *  - upper 4 bits: difference between encoded width and visible width
+ *  - lower 4 bits: difference between encoded height and visible height
+ */
+
 #include <stdlib.h>

 #include "avcodec.h"
--- a/libavcodec/vp6data.h
+++ b/libavcodec/vp6data.h
@ -1,7 +1,4 @@
-/**
- * @file
- * VP6 compatible video decoder
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP6 compatible video decoder
+ */
+
 #ifndef AVCODEC_VP6DATA_H
 #define AVCODEC_VP6DATA_H

--- a/libavcodec/vp6dsp.c
+++ b/libavcodec/vp6dsp.c
@ -1,7 +1,4 @@
-/**
- * @file
- * VP6 DSP-oriented functions
- *
+/*
 * Copyright (C) 2006  Aurelien Jacobs <aurel@gnuage.org>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP6 DSP-oriented functions
+ */
+
 #include "libavutil/common.h"
 #include "vp56dsp.h"

--- a/libavcodec/vp8data.h
+++ b/libavcodec/vp8data.h
@ -1,6 +1,4 @@
-/**
- * VP8 compatible video decoder
- *
+/*
 * Copyright (C) 2010 David Conrad
 * Copyright (C) 2010 Ronald S. Bultje
 *
@ -21,6 +19,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP8 compatible video decoder
+ */
+
 #ifndef AVCODEC_VP8DATA_H
 #define AVCODEC_VP8DATA_H

--- a/libavcodec/vp8dsp.c
+++ b/libavcodec/vp8dsp.c
@ -1,6 +1,4 @@
-/**
- * VP8 compatible video decoder
- *
+/*
 * Copyright (C) 2010 David Conrad
 * Copyright (C) 2010 Ronald S. Bultje
 *
@ -21,6 +19,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP8 compatible video decoder
+ */
+
 #include "dsputil.h"
 #include "vp8dsp.h"

--- a/libavcodec/vp8dsp.h
+++ b/libavcodec/vp8dsp.h
@ -1,6 +1,4 @@
-/**
- * VP8 compatible video decoder
- *
+/*
 * Copyright (C) 2010 David Conrad
 * Copyright (C) 2010 Ronald S. Bultje
 *
@ -21,6 +19,10 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * VP8 compatible video decoder
+ */

 #ifndef AVCODEC_VP8DSP_H
 #define AVCODEC_VP8DSP_H
--- a/libavcodec/yop.c
+++ b/libavcodec/yop.c
@ -1,5 +1,4 @@
-/**
- * @file
+/*
 * Psygnosis YOP decoder
 *
 * Copyright (C) 2010 Mohamed Naufal Basheer <naufal11@gmail.com>
--- a/libavformat/flv.h
+++ b/libavformat/flv.h
@ -1,5 +1,4 @@
-/**
- * @file
+/*
 * FLV common header
 *
 * Copyright (c) 2006 The Libav Project
@ -21,6 +20,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * FLV common header
+ */
+
 #ifndef AVFORMAT_FLV_H
 #define AVFORMAT_FLV_H

--- a/libavformat/yop.c
+++ b/libavformat/yop.c
@ -1,5 +1,4 @@
-/**
- * @file
+/*
 * Psygnosis YOP demuxer
 *
 * Copyright (C) 2010 Mohamed Naufal Basheer <naufal11@gmail.com>
--- a/libavutil/timer.h
+++ b/libavutil/timer.h
@ -1,7 +1,4 @@
-/**
- * @file
- * high precision timer, useful to profile code
- *
+/*
 * copyright (c) 2006 Michael Niedermayer <michaelni@gmx.at>
 *
 * This file is part of Libav.
@ -21,6 +18,11 @@
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

+/**
+ * @file
+ * high precision timer, useful to profile code
+ */
+
 #ifndef AVUTIL_TIMER_H
 #define AVUTIL_TIMER_H