RepoMirrors/mpv
1
0
Fork 0
mirror of https://github.com/mpv-player/mpv synced 2024-12-25 00:02:13 +00:00
Code Issues Releases Wiki Activity

random small fixes

Browse Source 
git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@22220 b3059339-0415-0410-9bf9-f77b7e298cf2
This commit is contained in:
diego 2007-02-14 23:44:01 +00:00
parent 077f4e7a2c
commit cb71a0169a
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
DOCS/tech/code-documentation.txt
View File

@ -37,11 +37,11 @@ What should be documented?
* its valid range
* where it is set (optional)
* where validity checking is done (optional, mandatory for variables which
are set by something external, eg user parameters, file information etc)
are set by something external, e.g. user parameters, file information etc)
- #define, typedefs, structs
* all global definitions
* all local definitions whose use is not imediatly clear by their name
* all local definitions whose use is not immediately clear by their name
(as a rule of thumb, it's better to document too much than not enough)
* all dependencies
@ -124,7 +124,7 @@ There are a couple of special tags for doxygen:
\warning <text>
Add a section for a warning.
\anchor <refname>
Set an invisible anchor which can be used to create a link with /ref.
Set an invisible anchor which can be used to create a link with \ref.
\ref <refname> [<text>]
Add a link to <refname>.