projects
/
ffmpeg.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
| inline |
side by side
(parent:
f6f95d4
)
doc: remove file name from @file directive in Doxygen usage example
author
Diego Biurrun
<diego@biurrun.de>
Thu, 14 Jul 2011 01:54:10 +0000
(
03:54
+0200)
committer
Diego 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
patch
|
blob
|
history
diff --git
a/doc/developer.texi
b/doc/developer.texi
index
45a4f44
..
208c119
100644
(file)
--- 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 ...
*/