Re: [MERGE] Initial netfilter mark patch for comment

From: Henrik Nordström <henrik_at_henriknordstrom.net>
Date: Sun, 22 Aug 2010 01:45:15 +0200

lör 2010-08-21 klockan 23:41 +0100 skrev Andrew Beverley:

> I have documented all the functions and class data members. Could you
> clarify whether *every* variable should be documented with doxygen
> comments (including short-lived temporary ones within functions), or
> just those that are part of classes/structs?

classes/structs.

temporary variables if their use may not be obvious to someone else
reading your code, but preferably code in such shape that variable use
is obvious.

> For example, should 'tos' in the function below have doxygen comments?

No need for that imho.

Regards
Henrik
Received on Sat Aug 21 2010 - 23:45:19 MDT

This archive was generated by hypermail 2.2.0 : Sun Aug 22 2010 - 12:00:05 MDT