U++ framework: Documentation » Notes on using T++ (comment on singals)

Home » Developing U++ » Documentation » Notes on using T++ (comment on singals)

Show: Today's Messages :: Polls :: Message Navigator
E-mail to friend

Notes on using T++ (comment on singals) [message #18944]

Sun, 02 November 2008 10:50

mirek
Messages: 14291
Registered: November 2005

Ultimate Member

Hi,

mdelfede freshly used T++ to document his new handy contribution to bazaar (a good sign Smile

and I have few comment:

First, I believe we should be using "short form" w.r.t. parmeteres. So while there is now:

bool�Handle(int�sig, Callback�const�&cb)

Installs a signal handler
sig ..................................Posix signal number
cb....................................Callback that will handle the signal

I would rather use

Installs a callback cb as handler of posix signal sig.

(both cb and sig being red, so it is still clear that these are params).

Second, please make attention that there are some predefined paragraph styles involved. Each section (which can document one or more coderefs) should start with 'begin' (which also introduces the horizontal ruler) and end with 'end'.

Mirek

Report message to a moderator