From cb71a0169afb9394c323a133284bc70f6db3b438 Mon Sep 17 00:00:00 2001 From: diego Date: Wed, 14 Feb 2007 23:44:01 +0000 Subject: random small fixes git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@22220 b3059339-0415-0410-9bf9-f77b7e298cf2 --- DOCS/tech/code-documentation.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'DOCS/tech') diff --git a/DOCS/tech/code-documentation.txt b/DOCS/tech/code-documentation.txt index da16b2a81c..b3d024e85a 100644 --- a/DOCS/tech/code-documentation.txt +++ b/DOCS/tech/code-documentation.txt @@ -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 Add a section for a warning. \anchor - 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 [] Add a link to . -- cgit v1.2.3