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 » Style & T++....
Re: Style & T++.... [message #18081 is a reply to message #18080] Wed, 10 September 2008 01:50 Go to previous messageGo to previous message
mirek is currently offline  mirek
Messages: 14267
Registered: November 2005
Ultimate Member
Mindtraveller wrote on Tue, 09 September 2008 17:42

I`d like to add some thoughts about template. If it is appropriate.

1. I think template should contain summary table of functions. Columns: function name (hyperlink to long description), function parameters, description. Table should be divided by functional groups. And functions inside each group are to be sorted alphabetically. Talking about size, summary table of constructors would look good.
3. Long descriptions of functions should go below summary tables.



IMO, this is not quite necessary. I have tried before and had always had problems distinguishing "short" and "long" description.

Moreover, table format does not work well - long singatures of methods go into more lines (at least, more likely) and are unreadable.

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
Previous Topic: SVN Folder Creation Requests
Next Topic: The very first taste of T++ icons in the left bar..
Goto Forum:
  


Current Time: Thu Aug 28 13:19:08 CEST 2025

Total time taken to generate the page: 0.06698 seconds