Re: [Setup-tool-hackers] Code conformance

[Hans Petter Jansson <hpj ximian com>]

> And ideally, we should start documenting the more important functions:
> 
> /**
>  * xst_ui_coffee_pot_set_enabled: Enable coffee pot.
>  * @pot: The CoffeePot to (en|dis)able. @state: Boolean, TRUE means enable.
>  *
>  * Helper to facilitate easy manipulation of coffee pots. Its native interface
>  * is way hairy, and in the common case, we just want to switch in on and off.
>  * 
>  * Return value: TRUE if the operation was successful, or FALSE if it
>  * couldn't be done without blocking.
>  **/
> 
> gboolean
> xst_ui_coffee_pot_set_enabled (CoffeePot *pot, gboolean state)
> {
> }

Uh, I meant:

/**
 * xst_ui_coffee_pot_set_enabled: Enable coffee pot.
 * @pot:   The CoffeePot to (en|dis)able.
 * @state: Boolean, TRUE means enable.
 *
 * Helper to facilitate easy manipulation of coffee pots. Its native interface
 * is way hairy, and in the common case, we just want to switch in on and off.
 *
 * Return value: TRUE if the operation was successful, or FALSE if it
 * couldn't be done without blocking.
 **/

gboolean
xst_ui_coffee_pot_set_enabled (CoffeePot *pot, gboolean state)
{
}

With the @pot and @state arg descriptions on separate lines. Sorry about that.

--
Hans Petter

_______________________________________________
setup-tool-hackers maillist  -  setup-tool-hackers@helixcode.com
http://lists.helixcode.com/mailman/listinfo/setup-tool-hackers