[pacman-dev] [PATCH 1/3] alpm.h: add Doxygen-style doc to package-related functions.

Rémy Oudompheng remyoudompheng at gmail.com
Wed Mar 2 02:12:43 EST 2011


On 2011/3/2 Rémy Oudompheng <remyoudompheng at gmail.com> wrote:
> I vote for compactness (at least in .h files). So I'd say my preferred
> formatting is

And either

/** The maximal number of open foobars */
static int max_open_foobars = 10;

or

/** The maximal number of open foobars
 *
 * This number is used when performing some action.
 *
 * @sa override_open_foobars(int)
 */
static int max_open_foobars = 10;

for short descriptions of non-function items.

-- 
Rémy.


More information about the pacman-dev mailing list