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++ » U++ Developers corner » Documentation and Topic++
Re: Documentation and Topic++ [message #16496 is a reply to message #16493] Wed, 18 June 2008 11:20 Go to previous messageGo to previous message
mirek is currently offline  mirek
Messages: 13979
Registered: November 2005
Ultimate Member
mdelfede wrote on Wed, 18 June 2008 03:55

Or, even better, a page for each function, or class or whathever.
A dialog with fixed fields for input, like this :
Title : xxxxxxxxxxxxxxxxxxxxxx

Description :
xxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxx

Usage :
xxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxx

Parameters :
xxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxx

Result :
xxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxx

Caveats :
xxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxx

Example :
xxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxx

See also :
xxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxx


that's all. Click OK and you have it autoformatted in richedit or whathever you like. A button to insert links would be good also. Quick to enter documentation, not loosing time to format it.
Of course, a button to get it back into dialog for editing.
BTW, I'd prefere a doc page for one item, too... putting 30-40 items with short description in one page is not enough and time consuming to look for info, IMHO.

Max



This is too long, if applied to each method.

Mirek
 
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message icon14.gif
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Previous Topic: Task: How to read GTK/Gnome settings
Next Topic: U++ infrastructure server...
Goto Forum:
  


Current Time: Mon May 13 02:48:28 CEST 2024

Total time taken to generate the page: 0.01847 seconds