Overview
Examples
Screenshots
Comparisons
Applications
Download
Documentation
Tutorials
Bazaar
Status & Roadmap
FAQ
Authors & License
Forums
Funding Ultimate++
Search on this site
Search in forums












SourceForge.net Logo
Home » Developing U++ » Documentation » Notes on using T++ (comment on singals)
Notes on using T++ (comment on singals) [message #18944] Sun, 02 November 2008 10:50 Go to previous message
mirek is currently offline  mirek
Messages: 13975
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
 
Read Message
Read Message
Previous Topic: Documentation how-to...
Next Topic: T++ working
Goto Forum:
  


Current Time: Thu Apr 18 11:34:06 CEST 2024

Total time taken to generate the page: 0.02130 seconds