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 » Documentations and others
Re: Documentations and others [message #24249 is a reply to message #24229] Thu, 07 January 2010 12:00 Go to previous messageGo to previous message
mdelfede is currently offline  mdelfede
Messages: 1307
Registered: September 2007
Ultimate Contributor
I agree, documentation (when present) is not bad at all; in particular Core and CtrlLib are well documented, besides some missing (and quite interesting) stuffs like Xml and others.

The main problem is documentation usage; to find help inside Ctrl or ArrayCtrl docs is painful.
Things thar (imho) are missing :

1- Some sort of index, both alphabetical and by cathegory.
Look for example in Ctrl docs... members are somehow grouped by cathegory, but completely scrambled alpabetically. If you look for a particular func, you must read all pages. Ditto for ArrayCtrl and others.

2- A sort of "see-also" link in each topic. That would greatly help topic and argument search.

BTW, a nice plot of class hyerarchy would be nice Smile

Ciao

Max
 
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Previous Topic: How to print documentation ?
Next Topic: Manual page
Goto Forum:
  


Current Time: Sun May 19 07:29:32 CEST 2024

Total time taken to generate the page: 0.01105 seconds