[FFmpeg-devel] [PATCH 1/2] ensure comment blocks that contain doxygen commands start with double asterix

Peter Ross pross at xvid.org
Wed Nov 21 09:53:08 CET 2012


---
 ffmpeg.c                      |    2 +-
 libavcodec/atrac3.c           |   16 ++++++++--------
 libavcodec/bfin/pixels_bfin.S |    2 +-
 libavcodec/cook.c             |    2 +-
 libavcodec/g729dec.c          |    2 +-
 libavcodec/idcinvideo.c       |    2 +-
 libavcodec/mmvideo.c          |    2 +-
 libavcodec/qdm2.c             |    4 ++--
 libavcodec/vp3.c              |    2 +-
 libavformat/internal.h        |    2 +-
 libavutil/avutil.h            |    2 +-
 libavutil/opt.h               |    2 +-
 12 files changed, 20 insertions(+), 20 deletions(-)

diff --git a/ffmpeg.c b/ffmpeg.c
index 0c98fb7..875463f 100644
--- a/ffmpeg.c
+++ b/ffmpeg.c
@@ -965,7 +965,7 @@ static void do_video_stats(OutputStream *ost, int frame_size)
     }
 }
 
-/*
+/**
  * Get and encode new output from any of the filtergraphs, without causing
  * activity.
  *
diff --git a/libavcodec/atrac3.c b/libavcodec/atrac3.c
index 101a887..b14fd46 100644
--- a/libavcodec/atrac3.c
+++ b/libavcodec/atrac3.c
@@ -123,7 +123,7 @@ static float gain_tab1[16];
 static float gain_tab2[31];
 
 
-/*
+/**
  * Regular 512 points IMDCT without overlapping, with the exception of the
  * swapping of odd bands caused by the reverse spectra of the QMF.
  *
@@ -202,7 +202,7 @@ static av_cold int atrac3_decode_close(AVCodecContext *avctx)
     return 0;
 }
 
-/*
+/**
  * Mantissa decoding
  *
  * @param selector     which table the output values are coded with
@@ -264,7 +264,7 @@ static void read_quant_spectral_coeffs(GetBitContext *gb, int selector,
     }
 }
 
-/*
+/**
  * Restore the quantized band spectrum coefficients
  *
  * @return subband count, fix for broken specification/files
@@ -321,7 +321,7 @@ static int decode_spectrum(GetBitContext *gb, float *output)
     return num_subbands;
 }
 
-/*
+/**
  * Restore the quantized tonal components
  *
  * @param components tonal components
@@ -405,7 +405,7 @@ static int decode_tonal_components(GetBitContext *gb,
     return component_count;
 }
 
-/*
+/**
  * Decode gain parameters for the coded bands
  *
  * @param block      the gainblock for the current band
@@ -440,7 +440,7 @@ static int decode_gain_control(GetBitContext *gb, GainBlock *block,
     return 0;
 }
 
-/*
+/**
  * Apply gain parameters and perform the MDCT overlapping part
  *
  * @param input   input buffer
@@ -497,7 +497,7 @@ static void gain_compensate_and_overlap(float *input, float *prev,
     memcpy(prev, &input[256], 256 * sizeof(*prev));
 }
 
-/*
+/**
  * Combine the tonal band spectrum and regular band spectrum
  *
  * @param spectrum        output spectrum buffer
@@ -624,7 +624,7 @@ static void channel_weighting(float *su1, float *su2, int *p3)
     }
 }
 
-/*
+/**
  * Decode a Sound Unit
  *
  * @param snd           the channel unit to be used
diff --git a/libavcodec/bfin/pixels_bfin.S b/libavcodec/bfin/pixels_bfin.S
index 3b987ae..995d7b8 100644
--- a/libavcodec/bfin/pixels_bfin.S
+++ b/libavcodec/bfin/pixels_bfin.S
@@ -84,7 +84,7 @@ apc$3: R6 = BYTEOP3P(R1:0, R3:2) (LO)    || [I2++M0] = R6   || R2 = [I1];
 DEFUN_END(add_pixels_clamped)
 
 
-/*
+/**
   motion compensation
   primitives
 
diff --git a/libavcodec/cook.c b/libavcodec/cook.c
index 0092f25..63f6be2 100644
--- a/libavcodec/cook.c
+++ b/libavcodec/cook.c
@@ -767,7 +767,7 @@ static int decouple_info(COOKContext *q, COOKSubpacket *p, int *decouple_tab)
     return 0;
 }
 
-/*
+/**
  * function decouples a pair of signals from a single signal via multiplication.
  *
  * @param q                 pointer to the COOKContext
diff --git a/libavcodec/g729dec.c b/libavcodec/g729dec.c
index 7c12b0e..ee0348f 100644
--- a/libavcodec/g729dec.c
+++ b/libavcodec/g729dec.c
@@ -187,7 +187,7 @@ static inline int get_parity(uint8_t value)
    return (0x6996966996696996ULL >> (value >> 2)) & 1;
 }
 
-/*
+/**
  * Decodes LSF (Line Spectral Frequencies) from L0-L3 (3.2.4).
  * @param lsfq [out] (2.13) quantized LSF coefficients
  * @param past_quantizer_outputs [in/out] (2.13) quantizer outputs from previous frames
diff --git a/libavcodec/idcinvideo.c b/libavcodec/idcinvideo.c
index 9185f88..a517d9d 100644
--- a/libavcodec/idcinvideo.c
+++ b/libavcodec/idcinvideo.c
@@ -76,7 +76,7 @@ typedef struct IdcinContext {
     uint32_t pal[256];
 } IdcinContext;
 
-/*
+/**
  * Find the lowest probability node in a Huffman table, and mark it as
  * being assigned to a higher probability.
  * @return the node index of the lowest unused node, or -1 if all nodes
diff --git a/libavcodec/mmvideo.c b/libavcodec/mmvideo.c
index b51d4fe..0120e9f 100644
--- a/libavcodec/mmvideo.c
+++ b/libavcodec/mmvideo.c
@@ -120,7 +120,7 @@ static int mm_decode_intra(MmContext * s, int half_horiz, int half_vert)
     return 0;
 }
 
-/*
+/**
  * @param half_horiz Half horizontal resolution (0 or 1)
  * @param half_vert Half vertical resolution (0 or 1)
  */
diff --git a/libavcodec/qdm2.c b/libavcodec/qdm2.c
index 08674be..892f96f 100644
--- a/libavcodec/qdm2.c
+++ b/libavcodec/qdm2.c
@@ -1165,7 +1165,7 @@ static void process_subpacket_12 (QDM2Context *q, QDM2SubPNode *node)
     synthfilt_build_sb_samples(q, &gb, length, 8, QDM2_SB_USED(q->sub_sampling));
 }
 
-/*
+/**
  * Process new subpackets for synthesis filter
  *
  * @param q       context
@@ -1199,7 +1199,7 @@ static void process_synthesis_subpackets (QDM2Context *q, QDM2SubPNode *list)
 }
 
 
-/*
+/**
  * Decode superblock, fill packet lists.
  *
  * @param q    context
diff --git a/libavcodec/vp3.c b/libavcodec/vp3.c
index 8a8c4ce..7e129f6 100644
--- a/libavcodec/vp3.c
+++ b/libavcodec/vp3.c
@@ -312,7 +312,7 @@ static av_cold int vp3_decode_end(AVCodecContext *avctx)
     return 0;
 }
 
-/*
+/**
  * This function sets up all of the various blocks mappings:
  * superblocks <-> fragments, macroblocks <-> fragments,
  * superblocks <-> macroblocks
diff --git a/libavformat/internal.h b/libavformat/internal.h
index 16a2c96..4a9ed53 100644
--- a/libavformat/internal.h
+++ b/libavformat/internal.h
@@ -240,7 +240,7 @@ AVChapter *avpriv_new_chapter(AVFormatContext *s, int id, AVRational time_base,
  */
 void ff_reduce_index(AVFormatContext *s, int stream_index);
 
-/*
+/**
  * Convert a relative url into an absolute url, given a base url.
  *
  * @param buf the buffer where output absolute url is written
diff --git a/libavutil/avutil.h b/libavutil/avutil.h
index db016a5..8f63e3b 100644
--- a/libavutil/avutil.h
+++ b/libavutil/avutil.h
@@ -26,7 +26,7 @@
  * external API header
  */
 
-/*
+/**
  * @mainpage
  *
  * @section ffmpeg_intro Introduction
diff --git a/libavutil/opt.h b/libavutil/opt.h
index 1a8a4a2..c168f59 100644
--- a/libavutil/opt.h
+++ b/libavutil/opt.h
@@ -439,7 +439,7 @@ void av_opt_free(void *obj);
  */
 int av_opt_flag_is_set(void *obj, const char *field_name, const char *flag_name);
 
-/*
+/**
  * Set all the options from a given dictionary on an object.
  *
  * @param obj a struct whose first element is a pointer to AVClass
-- 
1.7.10.4

-- Peter
(A907 E02F A6E5 0CD2 34CD 20D2 6760 79C5 AC40 DD6B)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121121/6e382f47/attachment.asc>


More information about the ffmpeg-devel mailing list