Remove '\p', '\c' and '\e' doxygen markup from doxy, as it should

improve plain text doxy readability.

See the thread: "[RFC] Should we use doxygen markup?".


git-svn-id: file:///var/local/repositories/ffmpeg/trunk@19122 9553f0bf-9b14-0410-a0b8-cfaf0461ba5b

cmdutils.h

@@ -73,8 +73,8 @@ double parse_number_or_die(const char *context, const char *numstr, int type, do
  * @param context the context of the value to be set (e.g. the
  * corresponding commandline option name)
  * @param timestr the string to be parsed
- * @param is_duration a flag which tells how to interpret \p timestr, if
- * not zero \p timestr is interpreted as a duration, otherwise as a
+ * @param is_duration a flag which tells how to interpret timestr, if
+ * not zero timestr is interpreted as a duration, otherwise as a
  * date
  *
  * @see parse_date()

libavcodec/ac3.h

@@ -132,7 +132,7 @@ void ff_ac3_bit_alloc_calc_psd(int8_t *exp, int start, int end, int16_t *psd,
 
 /**
  * Calculates the masking curve.
- * First, the excitation is calculated using parameters in \p s and the signal
+ * First, the excitation is calculated using parameters in s and the signal
  * power in each critical band.  The excitation is compared with a predefined
  * hearing threshold table to produce the masking curve.  If delta bit
  * allocation information is provided, it is used for adjusting the masking
@@ -161,7 +161,7 @@ int ff_ac3_bit_alloc_calc_mask(AC3BitAllocParameters *s, int16_t *band_psd,
 /**
  * Calculates bit allocation pointers.
  * The SNR is the difference between the masking curve and the signal.  AC-3
- * uses this value for each frequency bin to allocate bits.  The \p snroffset
+ * uses this value for each frequency bin to allocate bits.  The snroffset
  * parameter is a global adjustment to the SNR for all bins.
  *
  * @param[in]  mask       masking curve

libavcodec/internal.h

@@ -33,7 +33,7 @@
  * a pointer to an AVClass struct
  * @param[in] feature string containing the name of the missing feature
  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
- * If \p want_sample is non-zero, additional verbage will be added to the log
+ * If want_sample is non-zero, additional verbage will be added to the log
  * message which tells the user how to report samples to the development
  * mailing list.
  */
@@ -48,13 +48,13 @@ void ff_log_missing_feature(void *avc, const char *feature, int want_sample);
 void ff_log_ask_for_sample(void *avc, const char *msg);
 
 /**
- * Determines whether \p pix_fmt is a hardware accelerated format.
+ * Determines whether pix_fmt is a hardware accelerated format.
  */
 int ff_is_hwaccel_pix_fmt(enum PixelFormat pix_fmt);
 
 /**
- * Returns the hardware accelerated codec for codec \p codec_id and
- * pixel format \p pix_fmt.
+ * Returns the hardware accelerated codec for codec codec_id and
+ * pixel format pix_fmt.
  *
  * @param codec_id the codec to match
  * @param pix_fmt the pixel format to match

libavcodec/opt.h

@@ -87,8 +87,8 @@ typedef struct AVOption {
 
 
 /**
- * Looks for an option in \p obj. Looks only for the options which
- * have the flags set as specified in \p mask and \p flags (that is,
+ * Looks for an option in obj. Looks only for the options which
+ * have the flags set as specified in mask and flags (that is,
  * for which it is the case that opt->flags & mask == flags).
  *
  * @param[in] obj a pointer to a struct whose first element is a
@@ -108,7 +108,7 @@ attribute_deprecated const AVOption *av_set_string(void *obj, const char *name,
 
 /**
  * @return a pointer to the AVOption corresponding to the field set or
- * NULL if no matching AVOption exists, or if the value \p val is not
+ * NULL if no matching AVOption exists, or if the value val is not
  * valid
  * @see av_set_string3()
  */

libavcodec/pixdesc.h

@@ -86,8 +86,8 @@ typedef struct AVPixFmtDescriptor{
 extern const AVPixFmtDescriptor av_pix_fmt_descriptors[];
 
 /**
- * Reads a line from an image, and writes to \p dst the values of the
- * pixel format component \p c.
+ * Reads a line from an image, and writes to dst the values of the
+ * pixel format component c.
  *
  * @param data the array containing the pointers to the planes of the image
  * @param linesizes the array containing the linesizes of the image
@@ -95,10 +95,10 @@ extern const AVPixFmtDescriptor av_pix_fmt_descriptors[];
  * @param x the horizontal coordinate of the first pixel to read
  * @param y the vertical coordinate of the first pixel to read
  * @param w the width of the line to read, that is the number of
- * values to write to \p dst
+ * values to write to dst
  * @param read_pal_component if not zero and the format is a paletted
- * format writes to \p dst the values corresponding to the palette
- * component \p c in data[1], rather than the palette indexes in
+ * format writes to dst the values corresponding to the palette
+ * component c in data[1], rather than the palette indexes in
  * data[0]. The behavior is undefined if the format is not paletted.
  */
 static inline void read_line(uint16_t *dst, const uint8_t *data[4], const int linesize[4],

libavcodec/put_bits.h

@@ -52,10 +52,10 @@ typedef struct PutBitContext {
 } PutBitContext;
 
 /**
- * Initializes the PutBitContext \p s.
+ * Initializes the PutBitContext s.
  *
  * @param buffer the buffer where to put bits
- * @param buffer_size the size in bytes of \p buffer
+ * @param buffer_size the size in bytes of buffer
  */
 static inline void init_put_bits(PutBitContext *s, uint8_t *buffer, int buffer_size)
 {
@@ -123,16 +123,16 @@ static inline void flush_put_bits(PutBitContext *s)
 void align_put_bits(PutBitContext *s);
 
 /**
- * Puts the string \p s in the bitstream.
+ * Puts the string s in the bitstream.
  *
  * @param terminate_string 0-terminates the written string if value is 1
  */
 void ff_put_string(PutBitContext * pbc, const char *s, int terminate_string);
 
 /**
- * Copies the content of \p src to the bitstream.
+ * Copies the content of src to the bitstream.
  *
- * @param length the number of bits of \p src to copy
+ * @param length the number of bits of src to copy
  */
 void ff_copy_bits(PutBitContext *pb, const uint8_t *src, int length);
 
@@ -290,7 +290,7 @@ static inline void skip_put_bytes(PutBitContext *s, int n){
 /**
  * Skips the given number of bits.
  * Must only be used if the actual values in the bitstream do not matter.
- * If \p n is 0 the behavior is undefined.
+ * If n is 0 the behavior is undefined.
  */
 static inline void skip_put_bits(PutBitContext *s, int n){
 #ifdef ALT_BITSTREAM_WRITER

libavformat/rm.h

@@ -64,8 +64,8 @@ int ff_rm_read_mdpr_codecdata (AVFormatContext *s, ByteIOContext *pb,
  * @param flags pointer to an integer containing the packet flags, may be
                 updated
  * @param ts pointer to timestamp, may be updated
- * @return <0 on error, 0 if a packet was placed in the \p pkt pointer. A
- *         value >0 means that no data was placed in \p pkt, but that cached
+ * @return <0 on error, 0 if a packet was placed in the pkt pointer. A
+ *         value >0 means that no data was placed in pkt, but that cached
  *         data is available by calling ff_rm_retrieve_cache().
  */
 int ff_rm_parse_packet (AVFormatContext *s, ByteIOContext *pb,

libavformat/rtsp.h

@@ -207,7 +207,7 @@ typedef struct RTSPState {
 
     /** timestamp of the last RTSP command that we sent to the RTSP server.
      * This is used to calculate when to send dummy commands to keep the
-     * connection alive, in conjunction with \p timeout. */
+     * connection alive, in conjunction with timeout. */
     int64_t last_cmd_time;
 
     /** the negotiated data/packet transport protocol; e.g. RTP or RDT */

libavutil/base64.h

@@ -24,23 +24,23 @@
 #include <stdint.h>
 
 /**
- * Decodes the base64-encoded string in \p in and puts the decoded
- * data in \p out.
+ * Decodes the base64-encoded string in in and puts the decoded
+ * data in out.
  *
- * @param out_size size in bytes of the \p out buffer, it should be at
- * least 3/4 of the length of \p in
+ * @param out_size size in bytes of the out buffer, it should be at
+ * least 3/4 of the length of in
  * @return the number of bytes written, or a negative value in case of
  * error
  */
 int av_base64_decode(uint8_t *out, const char *in, int out_size);
 
 /**
- * Encodes in base64 the data in \p in and puts the resulting string
- * in \p out.
+ * Encodes in base64 the data in in and puts the resulting string
+ * in out.
  *
- * @param out_size size in bytes of the \p out string, it should be at
- * least ((\p in_size + 2) / 3) * 4 + 1
- * @param in_size size in bytes of the \p in buffer
+ * @param out_size size in bytes of the out string, it should be at
+ * least ((in_size + 2) / 3) * 4 + 1
+ * @param in_size size in bytes of the in buffer
  * @return the string containing the encoded data, or NULL in case of
  * error
  */

libavutil/log.h

@@ -39,7 +39,7 @@ struct AVCLASS {
 
     /**
      * A pointer to a function which returns the name of a context
-     * instance \p ctx associated with the class.
+     * instance ctx associated with the class.
      */
     const char* (*item_name)(void* ctx);
 

libavutil/mem.h

@@ -41,7 +41,7 @@
 #endif
 
 /**
- * Allocates a block of \p size bytes with alignment suitable for all
+ * Allocates a block of size bytes with alignment suitable for all
  * memory accesses (including vectors if available on the CPU).
  * @param size Size in bytes for the memory block to be allocated.
  * @return Pointer to the allocated block, NULL if the block cannot
@@ -52,8 +52,8 @@ void *av_malloc(unsigned int size) av_malloc_attrib av_alloc_size(1);
 
 /**
  * Allocates or reallocates a block of memory.
- * If \p ptr is NULL and \p size > 0, allocates a new block. If \p
- * size is zero, frees the memory block pointed to by \p ptr.
+ * If ptr is NULL and size > 0, allocates a new block. If \p
+ * size is zero, frees the memory block pointed to by ptr.
  * @param size Size in bytes for the memory block to be allocated or
  * reallocated.
  * @param ptr Pointer to a memory block already allocated with
@@ -75,7 +75,7 @@ void *av_realloc(void *ptr, unsigned int size) av_alloc_size(2);
 void av_free(void *ptr);
 
 /**
- * Allocates a block of \p size bytes with alignment suitable for all
+ * Allocates a block of size bytes with alignment suitable for all
  * memory accesses (including vectors if available on the CPU) and
  * zeroes all the bytes of the block.
  * @param size Size in bytes for the memory block to be allocated.
@@ -85,10 +85,10 @@ void av_free(void *ptr);
 void *av_mallocz(unsigned int size) av_malloc_attrib av_alloc_size(1);
 
 /**
- * Duplicates the string \p s.
+ * Duplicates the string s.
  * @param s string to be duplicated
  * @return Pointer to a newly allocated string containing a
- * copy of \p s or NULL if the string cannot be allocated.
+ * copy of s or NULL if the string cannot be allocated.
  */
 char *av_strdup(const char *s) av_malloc_attrib;
 

libavutil/rational.h

@@ -114,13 +114,13 @@ AVRational av_sub_q(AVRational b, AVRational c) av_const;
 AVRational av_d2q(double d, int max) av_const;
 
 /**
- * @return 1 if \q1 is nearer to \p q than \p q2, -1 if \p q2 is nearer
- * than \p q1, 0 if they have the same distance.
+ * @return 1 if q1 is nearer to q than q2, -1 if q2 is nearer
+ * than q1, 0 if they have the same distance.
  */
 int av_nearer_q(AVRational q, AVRational q1, AVRational q2);
 
 /**
- * Finds the nearest value in \p q_list to \p q.
+ * Finds the nearest value in q_list to q.
  * @param q_list an array of rationals terminated by {0, 0}
  * @return the index of the nearest value found in the array
  */