Prefer '///< ...' doxygen inline syntax over '/**< ... */'.
authorStefano Sabatini <stefano.sabatini-lala@poste.it>
Thu, 25 Mar 2010 22:46:32 +0000 (22:46 +0000)
committerStefano Sabatini <stefano.sabatini-lala@poste.it>
Thu, 25 Mar 2010 22:46:32 +0000 (22:46 +0000)
Originally committed as revision 22683 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavutil/error.h

index 5eb2ef2..3096baa 100644 (file)
@@ -29,8 +29,8 @@
 
 /* error handling */
 #if EDOM > 0
-#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
-#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
+#define AVERROR(e) (-(e))   ///< Returns a negative error code from a POSIX error code, to return from library functions.
+#define AVUNERROR(e) (-(e)) ///< Returns a POSIX error code from a library function error return value.
 #else
 /* Some platforms have E* and errno already negated. */
 #define AVERROR(e) (e)
 #endif
 
 #if LIBAVUTIL_VERSION_MAJOR < 51
-#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< Invalid data found when processing input */
-#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
-#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory */
-#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< Unknown format */
-#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< Not enough memory */
-#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename */
-#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< Unknown error */
+#define AVERROR_INVALIDDATA AVERROR(EINVAL)  ///< Invalid data found when processing input
+#define AVERROR_IO          AVERROR(EIO)     ///< I/O error
+#define AVERROR_NOENT       AVERROR(ENOENT)  ///< No such file or directory
+#define AVERROR_NOFMT       AVERROR(EILSEQ)  ///< Unknown format
+#define AVERROR_NOMEM       AVERROR(ENOMEM)  ///< Not enough memory
+#define AVERROR_NUMEXPECTED AVERROR(EDOM)    ///< Number syntax expected in filename
+#define AVERROR_UNKNOWN     AVERROR(EINVAL)  ///< Unknown error
 #endif
 
-#define AVERROR_EOF         AVERROR(EPIPE)   /**< End of file */
-#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported */
+#define AVERROR_EOF         AVERROR(EPIPE)   ///< End of file
+#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  ///< Operation not supported
 
-#define AVERROR_PATCHWELCOME    (-MKTAG('P','A','W','E')) /**< Not yet implemented in FFmpeg, patches welcome */
+#define AVERROR_PATCHWELCOME    (-MKTAG('P','A','W','E')) ///< Not yet implemented in FFmpeg, patches welcome
 
 #if LIBAVUTIL_VERSION_MAJOR > 50
-#define AVERROR_INVALIDDATA     (-MKTAG('I','N','D','A')) /**< Invalid data found when processing input */
-#define AVERROR_NUMEXPECTED     (-MKTAG('N','U','E','X')) /**< Number syntax expected in filename */
+#define AVERROR_INVALIDDATA     (-MKTAG('I','N','D','A')) ///< Invalid data found when processing input
+#define AVERROR_NUMEXPECTED     (-MKTAG('N','U','E','X')) ///< Number syntax expected in filename
 #endif
 
 #endif /* AVUTIL_ERROR_H */