doc: remove file name from @file directive in Doxygen usage example
authorDiego Biurrun <diego@biurrun.de>
Thu, 14 Jul 2011 01:54:10 +0000 (03:54 +0200)
committerDiego Biurrun <diego@biurrun.de>
Thu, 14 Jul 2011 18:51:01 +0000 (20:51 +0200)
The file name is redundant and brittle across file renamings.

doc/developer.texi

index 45a4f44..208c119 100644 (file)
@@ -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 ...
  */