>> I would like to add comments in these lines
>> in all Signals and Attributes sections:

> This is in src/CodeGen.hs . However, wouldn't that be a lot of  
> repeated information what should be in one place only (e.g. a tutorial).

Yes. But I understand the current situation should be something
like [1]. Also, in the same example [1], 'zZ' attribute would
have its documentation duplicated in the corresponding getter
and setter functions.

I think documentation on deprecated functions should be
removed, and in one place we should say how to replace the new
way of doing things for the old. But if we do need to write
documentation on deprecated API, maybe this standard comment
on Signal and Attributes sections could be more practical.

Thanks,
Maurício

-- [1]
-----------
-- Signals

-- | This is emmited when X is True and Y is activated. Note
-- that depending on the value of attribute 'zZ' neither X can
-- be True nor Y can be activated.

somethingHappened :: Signal ...


----
-- Deprecated

-- | This sets callbacks to be called when X is True and Y is
-- activated. Note that depending on the value o attribute 'zZ'
-- neither X can be True nor Y can be activated.

onSomethingHappened ::
afterSomethingHappened ::


------------------------------------------------------------------------------
This SF.net email is sponsored by:
High Quality Requirements in a Collaborative Environment.
Download a free trial of Rational Requirements Composer Now!
http://p.sf.net/sfu/www-ibm-com
_______________________________________________
Gtk2hs-devel mailing list
Gtk2hs-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/gtk2hs-devel

Reply via email to