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 » Community » PR, media coverage, articles and documentation » Is current t++ documentation style too verbose?
Is current t++ documentation style too verbose? [message #3022] Wed, 03 May 2006 21:06 Go to next message
mirek is currently offline  mirek
Messages: 13986
Registered: November 2005
Ultimate Member
I have now seen this nice piece of work on U++ wiki:

http://upp.wikispaces.com/Strings

and also have discussion with one of users per icq and now I am thinking that perhaps we should adopt less verbose and more space (and time) saving style of documentation, more or less drop the "parameter" documentation in most places - it is true that often there is a little to be written about individual parameters, so often it ends like

len.......The length.

which is quite stupid...

Opinions?

Mirek
Re: Is current t++ documentation style too verbose? [message #3029 is a reply to message #3022] Thu, 04 May 2006 00:54 Go to previous messageGo to next message
fudadmin is currently offline  fudadmin
Messages: 1321
Registered: November 2005
Location: Kaunas, Lithuania
Ultimate Contributor
Administrator
100 times "yes"! And, I think, I had mentioned before:
1. first of all - short descriptions (general idea) of all classes.
2. a small good example is worth of 1000 words.
Re: Is current t++ documentation style too verbose? [message #3030 is a reply to message #3029] Thu, 04 May 2006 05:18 Go to previous messageGo to next message
mirek is currently offline  mirek
Messages: 13986
Registered: November 2005
Ultimate Member
fudadmin wrote on Wed, 03 May 2006 18:54

100 times "yes"! And, I think, I had mentioned before:
1. first of all - short descriptions (general idea) of all classes.
2. a small good example is worth of 1000 words.


Well, I guess, we did agree on that, however, there still needs to be a form of "reference", listing all methods...

Mirek
Re: Is current t++ documentation style too verbose? [message #3031 is a reply to message #3030] Thu, 04 May 2006 13:05 Go to previous message
fudadmin is currently offline  fudadmin
Messages: 1321
Registered: November 2005
Location: Kaunas, Lithuania
Ultimate Contributor
Administrator
List all methods?
1. declare your var and use Assistant++...
2. or enter e.g "Ctrl::" in your code (filters would be usefull!..)
3. or go (Navigate, Jump) to the appropriate *.h *.cpp file.

But when after 10 minutes "navigation" to find appropriate Topic++ file I find that someone wastes his time explaining what length is and I can't find more difficult classes analysis that makes me really angry... Smile

And btw, how is the situation with F1?
Previous Topic: How to disable the dos prompt ? (-mwindows)
Next Topic: Linux-oriented field report
Goto Forum:
  


Current Time: Wed Jun 19 02:20:11 CEST 2024

Total time taken to generate the page: 0.01452 seconds