Mercurial > mplayer.hg
comparison DOCS/tech/code-documentation.txt @ 13302:05d3254e05b1
typos, wording
author | diego |
---|---|
date | Fri, 10 Sep 2004 10:15:50 +0000 |
parents | fb8f8882fb6a |
children | 335964188675 |
comparison
equal
deleted
inserted
replaced
13301:638673d1f83a | 13302:05d3254e05b1 |
---|---|
13 | 13 |
14 Doxygen | 14 Doxygen |
15 ------- | 15 ------- |
16 | 16 |
17 MPlayer uses doxygen for its code documentation. It generates HTML files | 17 MPlayer uses doxygen for its code documentation. It generates HTML files |
18 which contain the specially tagged comment lines from the code including | 18 which contain specially tagged comment lines from the code including |
19 cross references. To generate it type `make doxygen` in the source root | 19 cross references. To generate it type `make doxygen` in the source root |
20 directory. It will generate the files in DOCS/tech/doxygen. To clear them | 20 directory. It will generate the files in DOCS/tech/doxygen. To clear them |
21 again, you can use `make doxygen_clean`. | 21 again, you can use `make doxygen_clean`. |
22 For further information about doxygen and its sources please have a look | 22 For further information about doxygen and its sources please have a look |
23 at their website: http://doxygen.sf.net | 23 at their website: http://doxygen.sf.net |
39 * where validity checking is done (optional, mandatory for variables which | 39 * where validity checking is done (optional, mandatory for variables which |
40 are set by something external, eg user parameters, file information etc) | 40 are set by something external, eg user parameters, file information etc) |
41 | 41 |
42 - #define, typedefs, structs | 42 - #define, typedefs, structs |
43 * all global definitions | 43 * all global definitions |
44 * all local definitions whos use is not imediatly clear by their name | 44 * all local definitions whose use is not imediatly clear by their name |
45 (as a rule of thumb, it's better to document too much then not enough) | 45 (as a rule of thumb, it's better to document too much than not enough) |
46 * all dependencies | 46 * all dependencies |
47 | 47 |
48 - non-trivial parts of the code | 48 - non-trivial parts of the code |
49 * tricky parts | 49 * tricky parts |
50 * important parts | 50 * important parts |