[FFmpeg-cvslog] doc: remove file name from @file directive in Doxygen usage example

Diego Biurrun git at videolan.org
Fri Jul 15 17:58:57 CEST 2011


ffmpeg | branch: master | Diego Biurrun <diego at biurrun.de> | Thu Jul 14 03:54:10 2011 +0200| [a2f31564b4759c02c81f3f4d1be359eb4a18f050] | committer: Diego Biurrun

doc: remove file name from @file directive in Doxygen usage example

The file name is redundant and brittle across file renamings.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=a2f31564b4759c02c81f3f4d1be359eb4a18f050
---

 doc/developer.texi |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/doc/developer.texi b/doc/developer.texi
index 45a4f44..208c119 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -92,7 +92,7 @@ above them explaining what the function does, even if it is just one sentence.
 All structures and their member variables should be documented, too.
 @example
 /**
- * @@file mpeg.c
+ * @@file
  * MPEG codec.
  * @@author ...
  */



More information about the ffmpeg-cvslog mailing list