← Back to branch summary

~chtsanti/squid/icap-max-connections

« back to all changes in this revision

Viewing changes to doc/Programming-Guide/02_CodingConventions.dox

  • Committer: Christos Tsantilas
  • Date: 2009-04-11 09:00:59 UTC
  • mfrom: (9294.1.333 trunk)
  • Revision ID: chtsanti@users.sourceforge.net-20090411090059-8n47p1kyy1cqfqkn
Merge From trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Programming-Guide/02_CodingConventions.dox
121
121
\endverbatim
122
122
 
123
123
\par    Alternatively
124
 
        when a state or other context-dependant object is returned the \b \return
 
124
        when a state or other context-dependant object is returned the \b \\return
125
125
        tag is used. It is followed by a description of the object and ideally its
126
126
        content.
127
127
 
130
130
 
131
131
\par    Simple functions
132
132
        do not exactly need a detailed description of their operation.
133
 
        The \link PARAM input parameters \endlink and \link RETVAL Return \endlink
134
 
        value should be enough for any developer to understand the function.
 
133
        The \ref PARAM and \ref RETVAL 
 
134
        should be enough for any developer to understand the function.
135
135
 
136
136
\par    Long or Complex Functions
137
137
        do however need some commenting.
144
144
\par
145
145
        Each of these design blocks inside the function should be given a comment
146
146
        indicating what they do. The comments should begin with
147
 
        \verbatim /** \par \endverbatim
 
147
        \verbatim /** \\par \endverbatim
148
148
        The resulting function description will then contain a paragraph on each of the
149
149
        blocks in the order they occur in the function.
150
150