[FFmpeg-cvslog] doxygen: do not include license boilerplate in Doxygen documentation

Diego Biurrun git at videolan.org
Fri Jul 15 17:58:58 CEST 2011


ffmpeg | branch: master | Diego Biurrun <diego at biurrun.de> | Thu Jul 14 03:11:19 2011 +0200| [6168781f70ebac7da557207750d14f57c3cd4cb3] | committer: Diego Biurrun

doxygen: do not include license boilerplate in Doxygen documentation

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=6168781f70ebac7da557207750d14f57c3cd4cb3
---

 libavcodec/huffman.c   |    9 ++++++---
 libavcodec/huffman.h   |    9 ++++++---
 libavcodec/vorbis.c    |   12 +++++++-----
 libavcodec/vorbisdec.c |   12 +++++++-----
 libavcodec/vp5.c       |   10 ++++++----
 libavcodec/vp56.c      |   10 ++++++----
 libavcodec/vp56.h      |   10 ++++++----
 libavcodec/vp56data.c  |   10 ++++++----
 libavcodec/vp56data.h  |   10 ++++++----
 libavcodec/vp5data.h   |   10 ++++++----
 libavcodec/vp6.c       |   18 ++++++++++--------
 libavcodec/vp6data.h   |   10 ++++++----
 libavcodec/vp6dsp.c    |   10 ++++++----
 libavcodec/vp8data.h   |    9 ++++++---
 libavcodec/vp8dsp.c    |    9 ++++++---
 libavcodec/vp8dsp.h    |    8 +++++---
 libavcodec/yop.c       |    3 +--
 libavformat/flv.h      |    8 ++++++--
 libavformat/yop.c      |    3 +--
 libavutil/timer.h      |   10 ++++++----
 20 files changed, 115 insertions(+), 75 deletions(-)

diff --git a/libavcodec/huffman.c b/libavcodec/huffman.c
index 211ea63..4fb6530 100644
--- 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"
diff --git a/libavcodec/huffman.h b/libavcodec/huffman.h
index 4a60187..5625313 100644
--- 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 at 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
 
diff --git a/libavcodec/vorbis.c b/libavcodec/vorbis.c
index f413170..8ff24ab 100644
--- 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"
diff --git a/libavcodec/vorbisdec.c b/libavcodec/vorbisdec.c
index 9fc6068..445e68e 100644
--- 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>
 
diff --git a/libavcodec/vp5.c b/libavcodec/vp5.c
index 807309f..a057d9b 100644
--- a/libavcodec/vp5.c
+++ b/libavcodec/vp5.c
@@ -1,7 +1,4 @@
-/**
- * @file
- * VP5 compatible video decoder
- *
+/*
  * Copyright (C) 2006  Aurelien Jacobs <aurel at 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>
 
diff --git a/libavcodec/vp56.c b/libavcodec/vp56.c
index a181978..5c7e93e 100644
--- 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 at 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"
 
diff --git a/libavcodec/vp56.h b/libavcodec/vp56.h
index 5a55f7d..8bb7251 100644
--- 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 at 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
 
diff --git a/libavcodec/vp56data.c b/libavcodec/vp56data.c
index 7a41876..aa1dcef 100644
--- 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 at 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 };
diff --git a/libavcodec/vp56data.h b/libavcodec/vp56data.h
index 7be5921..b1f2710 100644
--- 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 at 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
 
diff --git a/libavcodec/vp5data.h b/libavcodec/vp5data.h
index 11144a3..b11b99d 100644
--- a/libavcodec/vp5data.h
+++ b/libavcodec/vp5data.h
@@ -1,7 +1,4 @@
-/**
- * @file
- * VP5 compatible video decoder
- *
+/*
  * Copyright (C) 2006  Aurelien Jacobs <aurel at 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
 
diff --git a/libavcodec/vp6.c b/libavcodec/vp6.c
index 4f3f402..42828d8 100644
--- a/libavcodec/vp6.c
+++ b/libavcodec/vp6.c
@@ -1,13 +1,6 @@
-/**
- * @file
- * VP6 compatible video decoder
- *
+/*
  * Copyright (C) 2006  Aurelien Jacobs <aurel at 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"
diff --git a/libavcodec/vp6data.h b/libavcodec/vp6data.h
index 2ba3ef3..9a11f89 100644
--- a/libavcodec/vp6data.h
+++ b/libavcodec/vp6data.h
@@ -1,7 +1,4 @@
-/**
- * @file
- * VP6 compatible video decoder
- *
+/*
  * Copyright (C) 2006  Aurelien Jacobs <aurel at 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
 
diff --git a/libavcodec/vp6dsp.c b/libavcodec/vp6dsp.c
index 64282a5..54a96ed 100644
--- a/libavcodec/vp6dsp.c
+++ b/libavcodec/vp6dsp.c
@@ -1,7 +1,4 @@
-/**
- * @file
- * VP6 DSP-oriented functions
- *
+/*
  * Copyright (C) 2006  Aurelien Jacobs <aurel at 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"
 
diff --git a/libavcodec/vp8data.h b/libavcodec/vp8data.h
index 4ea4581..a48b0f6 100644
--- 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
 
diff --git a/libavcodec/vp8dsp.c b/libavcodec/vp8dsp.c
index 159c070..89c3453 100644
--- 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"
 
diff --git a/libavcodec/vp8dsp.h b/libavcodec/vp8dsp.h
index e2fb8e7..5429e98 100644
--- 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
diff --git a/libavcodec/yop.c b/libavcodec/yop.c
index 1f1314b..e0b2654 100644
--- a/libavcodec/yop.c
+++ b/libavcodec/yop.c
@@ -1,5 +1,4 @@
-/**
- * @file
+/*
  * Psygnosis YOP decoder
  *
  * Copyright (C) 2010 Mohamed Naufal Basheer <naufal11 at gmail.com>
diff --git a/libavformat/flv.h b/libavformat/flv.h
index c86e20a..6418b27 100644
--- 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
 
diff --git a/libavformat/yop.c b/libavformat/yop.c
index e367187..bc29b08 100644
--- a/libavformat/yop.c
+++ b/libavformat/yop.c
@@ -1,5 +1,4 @@
-/**
- * @file
+/*
  * Psygnosis YOP demuxer
  *
  * Copyright (C) 2010 Mohamed Naufal Basheer <naufal11 at gmail.com>
diff --git a/libavutil/timer.h b/libavutil/timer.h
index a2ca5cf..341d508 100644
--- 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 at 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
 



More information about the ffmpeg-cvslog mailing list