doxygen: fix wrong comment syntax, //< vs. ///<
authorDiego Biurrun <diego@biurrun.de>
Fri, 5 Aug 2011 11:15:04 +0000 (13:15 +0200)
committerDiego Biurrun <diego@biurrun.de>
Fri, 26 Aug 2011 16:34:28 +0000 (18:34 +0200)
13 files changed:
avconv.c
ffmpeg.c
libavcodec/aac.h
libavcodec/aacps.c
libavcodec/aacps.h
libavcodec/aacps_tablegen.h
libavcodec/avcodec.h
libavcodec/mpeg4audio.h
libavcodec/mpegvideo.h
libavcodec/snow.c
libavcodec/truespeech.c
libavcodec/vp3.c
libavfilter/vf_drawbox.c

index 57721f8..64b2347 100644 (file)
--- a/avconv.c
+++ b/avconv.c
@@ -90,9 +90,9 @@ typedef struct StreamMap {
  * select an input file for an output file
  */
 typedef struct MetadataMap {
-    int  file;      //< file index
-    char type;      //< type of metadata to copy -- (g)lobal, (s)tream, (c)hapter or (p)rogram
-    int  index;     //< stream/chapter/program number
+    int  file;      ///< file index
+    char type;      ///< type of metadata to copy -- (g)lobal, (s)tream, (c)hapter or (p)rogram
+    int  index;     ///< stream/chapter/program number
 } MetadataMap;
 
 static const OptionDef options[];
index c4ac3f9..f2e5bae 100644 (file)
--- a/ffmpeg.c
+++ b/ffmpeg.c
@@ -89,9 +89,9 @@ typedef struct StreamMap {
  * select an input file for an output file
  */
 typedef struct MetadataMap {
-    int  file;      //< file index
-    char type;      //< type of metadata to copy -- (g)lobal, (s)tream, (c)hapter or (p)rogram
-    int  index;     //< stream/chapter/program number
+    int  file;      ///< file index
+    char type;      ///< type of metadata to copy -- (g)lobal, (s)tream, (c)hapter or (p)rogram
+    int  index;     ///< stream/chapter/program number
 } MetadataMap;
 
 typedef struct ChapterMap {
index 4861ec0..0653f81 100644 (file)
@@ -104,11 +104,11 @@ enum CouplingPoint {
  * Output configuration status
  */
 enum OCStatus {
-    OC_NONE,        //< Output unconfigured
-    OC_TRIAL_PCE,   //< Output configuration under trial specified by an inband PCE
-    OC_TRIAL_FRAME, //< Output configuration under trial specified by a frame header
-    OC_GLOBAL_HDR,  //< Output configuration set in a global header but not yet locked
-    OC_LOCKED,      //< Output configuration locked in place
+    OC_NONE,        ///< Output unconfigured
+    OC_TRIAL_PCE,   ///< Output configuration under trial specified by an inband PCE
+    OC_TRIAL_FRAME, ///< Output configuration under trial specified by a frame header
+    OC_GLOBAL_HDR,  ///< Output configuration set in a global header but not yet locked
+    OC_LOCKED,      ///< Output configuration locked in place
 };
 
 /**
index 93bdd91..d7d6ef8 100644 (file)
@@ -28,9 +28,9 @@
 #include "aacps_tablegen.h"
 #include "aacpsdata.c"
 
-#define PS_BASELINE 0  //< Operate in Baseline PS mode
-                       //< Baseline implies 10 or 20 stereo bands,
-                       //< mixing mode A, and no ipd/opd
+#define PS_BASELINE 0  ///< Operate in Baseline PS mode
+                       ///< Baseline implies 10 or 20 stereo bands,
+                       ///< mixing mode A, and no ipd/opd
 
 #define numQMFSlots 32 //numTimeSlots * RATE
 
@@ -654,7 +654,7 @@ static void decorrelation(PSContext *ps, float (*out)[32][2], const float (*s)[3
     const int8_t *k_to_i = is34 ? k_to_i_34 : k_to_i_20;
     const float peak_decay_factor = 0.76592833836465f;
     const float transient_impact  = 1.5f;
-    const float a_smooth          = 0.25f; //< Smoothing coefficient
+    const float a_smooth          = 0.25f; ///< Smoothing coefficient
     int i, k, m, n;
     int n0 = 0, nL = 32;
     static const int link_delay[] = { 3, 4, 5 };
index 59a9bff..124fbee 100644 (file)
@@ -52,11 +52,11 @@ typedef struct {
     int    num_env;
     int    enable_ipdopd;
     int    border_position[PS_MAX_NUM_ENV+1];
-    int8_t iid_par[PS_MAX_NUM_ENV][PS_MAX_NR_IIDICC]; //<Inter-channel Intensity Difference Parameters
-    int8_t icc_par[PS_MAX_NUM_ENV][PS_MAX_NR_IIDICC]; //<Inter-Channel Coherence Parameters
+    int8_t iid_par[PS_MAX_NUM_ENV][PS_MAX_NR_IIDICC]; ///< Inter-channel Intensity Difference Parameters
+    int8_t icc_par[PS_MAX_NUM_ENV][PS_MAX_NR_IIDICC]; ///< Inter-Channel Coherence Parameters
     /* ipd/opd is iid/icc sized so that the same functions can handle both */
-    int8_t ipd_par[PS_MAX_NUM_ENV][PS_MAX_NR_IIDICC]; //<Inter-channel Phase Difference Parameters
-    int8_t opd_par[PS_MAX_NUM_ENV][PS_MAX_NR_IIDICC]; //<Overall Phase Difference Parameters
+    int8_t ipd_par[PS_MAX_NUM_ENV][PS_MAX_NR_IIDICC]; ///< Inter-channel Phase Difference Parameters
+    int8_t opd_par[PS_MAX_NUM_ENV][PS_MAX_NR_IIDICC]; ///< Overall Phase Difference Parameters
     int    is34bands;
     int    is34bands_old;
 
index 492cb0c..5041f44 100644 (file)
@@ -139,7 +139,7 @@ static void ps_tableinit(void)
     }
 
     for (iid = 0; iid < 46; iid++) {
-        float c = iid_par_dequant[iid]; //<Linear Inter-channel Intensity Difference
+        float c = iid_par_dequant[iid]; ///< Linear Inter-channel Intensity Difference
         float c1 = (float)M_SQRT2 / sqrtf(1.0f + c*c);
         float c2 = c * c1;
         for (icc = 0; icc < 8; icc++) {
index c0dcae5..b47d41e 100644 (file)
@@ -2840,8 +2840,8 @@ typedef struct AVCodecContext {
      * - decoding: Set by user, otherwise the default is used.
      */
     int thread_type;
-#define FF_THREAD_FRAME   1 //< Decode more than one frame at once
-#define FF_THREAD_SLICE   2 //< Decode more than one part of a single frame at once
+#define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
+#define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
 
     /**
      * Which multithreading methods are in use by the codec.
index 2d2b4a2..c729c04 100644 (file)
@@ -31,13 +31,13 @@ typedef struct {
     int sampling_index;
     int sample_rate;
     int chan_config;
-    int sbr; //< -1 implicit, 1 presence
+    int sbr; ///< -1 implicit, 1 presence
     int ext_object_type;
     int ext_sampling_index;
     int ext_sample_rate;
     int ext_chan_config;
     int channels;
-    int ps;  //< -1 implicit, 1 presence
+    int ps;  ///< -1 implicit, 1 presence
 } MPEG4AudioConfig;
 
 extern const int ff_mpeg4audio_sample_rates[16];
index 00293db..47c8e8a 100644 (file)
@@ -298,7 +298,7 @@ typedef struct MpegEncContext {
     Picture *current_picture_ptr;  ///< pointer to the current picture
     int picture_count;             ///< number of allocated pictures (MAX_PICTURE_COUNT * avctx->thread_count)
     int picture_range_start, picture_range_end; ///< the part of picture that this context can allocate in
-    uint8_t *visualization_buffer[3]; //< temporary buffer vor MV visualization
+    uint8_t *visualization_buffer[3]; ///< temporary buffer vor MV visualization
     int last_dc[3];                ///< last DC values for MPEG1
     int16_t *dc_val_base;
     int16_t *dc_val[3];            ///< used for mpeg4 DC prediction, all 3 arrays must be continuous
index b87d828..2af5d23 100644 (file)
@@ -3306,7 +3306,7 @@ static void update_last_header_values(SnowContext *s){
 
 static int qscale2qlog(int qscale){
     return rint(QROOT*log(qscale / (float)FF_QP2LAMBDA)/log(2))
-           + 61*QROOT/8; //<64 >60
+           + 61*QROOT/8; ///< 64 > 60
 }
 
 static int ratecontrol_1pass(SnowContext *s, AVFrame *pict)
index f889775..6b6d131 100644 (file)
  */
 typedef struct {
     /* input data */
-    int16_t vector[8];  //< input vector: 5/5/4/4/4/3/3/3
-    int offset1[2];     //< 8-bit value, used in one copying offset
-    int offset2[4];     //< 7-bit value, encodes offsets for copying and for two-point filter
-    int pulseoff[4];    //< 4-bit offset of pulse values block
-    int pulsepos[4];    //< 27-bit variable, encodes 7 pulse positions
-    int pulseval[4];    //< 7x2-bit pulse values
-    int flag;           //< 1-bit flag, shows how to choose filters
+    int16_t vector[8];  ///< input vector: 5/5/4/4/4/3/3/3
+    int offset1[2];     ///< 8-bit value, used in one copying offset
+    int offset2[4];     ///< 7-bit value, encodes offsets for copying and for two-point filter
+    int pulseoff[4];    ///< 4-bit offset of pulse values block
+    int pulsepos[4];    ///< 27-bit variable, encodes 7 pulse positions
+    int pulseval[4];    ///< 7x2-bit pulse values
+    int flag;           ///< 1-bit flag, shows how to choose filters
     /* temporary data */
     int filtbuf[146];   // some big vector used for storing filters
     int prevfilt[8];    // filter from previous frame
index 13a3bda..462a482 100644 (file)
@@ -225,7 +225,7 @@ typedef struct Vp3DecodeContext {
 
     /* these arrays need to be on 16-byte boundaries since SSE2 operations
      * index into them */
-    DECLARE_ALIGNED(16, int16_t, qmat)[3][2][3][64];     //<qmat[qpi][is_inter][plane]
+    DECLARE_ALIGNED(16, int16_t, qmat)[3][2][3][64];     ///< qmat[qpi][is_inter][plane]
 
     /* This table contains superblock_count * 16 entries. Each set of 16
      * numbers corresponds to the fragment indexes 0..15 of the superblock.
index 37c48c5..ab5cb03 100644 (file)
@@ -34,7 +34,7 @@ enum { Y, U, V, A };
 typedef struct {
     int x, y, w, h;
     unsigned char yuv_color[4];
-    int vsub, hsub;   //< chroma subsampling
+    int vsub, hsub;   ///< chroma subsampling
 } DrawBoxContext;
 
 static av_cold int init(AVFilterContext *ctx, const char *args, void *opaque)