]> git.sesse.net Git - ffmpeg/blobdiff - libavutil/error.h
Sort AV_CPU_FLAG* by value.
[ffmpeg] / libavutil / error.h
index abf9a57d701b8b1ff1e74bac2ff8290d909fd0e1..28fa925793d5bfdc23d92f16c5633a7f25ab5942 100644 (file)
 #endif
 
 /**
- * Puts a description of the AVERROR code errnum in errbuf.
+ * Put a description of the AVERROR code errnum in errbuf.
  * In case of failure the global variable errno is set to indicate the
- * error.
+ * error. Even in case of failure av_strerror() will print a generic
+ * error message indicating the errnum provided to errbuf.
  *
+ * @param errnum      error code to describe
+ * @param errbuf      buffer to which description is written
  * @param errbuf_size the size in bytes of errbuf
- * @return 0 on success, a negative value otherwise
+ * @return 0 on success, a negative value if a description for errnum
+ * cannot be found
  */
 int av_strerror(int errnum, char *errbuf, size_t errbuf_size);