Home » Developing U++ » U++ Developers corner » Documentation and Topic++
Re: Documentation and Topic++ [message #16499 is a reply to message #16496] |
Wed, 18 June 2008 12:05 |
mdelfede
Messages: 1307 Registered: September 2007
|
Ultimate Contributor |
|
|
luzr wrote on Wed, 18 June 2008 11:20 |
This is too long, if applied to each method.
Mirek
|
I'd say that it forces to document extensively each method... which is what we need
BTW, usually when I look for help, I look for a cathegory in some index (graphics, strings, path, threading....), then inside it for the function I need.
So, a good topics "group" index, pointing to a group of related stuffs and so on. The alphabetical index is for reverse search.
Usually my problem with upp is that I don't know the name of a function that I'd like to use.... well, usually I don't ever know it it exists. It's quite less often that I know function name and I search for the purpose... that happens only when I dig inside upp code. Then, I'd like to have also some example of usage... and maybe a link to a reference project using it.
I think that we don't need all the fields filled immediately... that can be done on time while using it. We just need the skeleton to do it.
For example :
string
string::cat() <short description>
string::cat()
long desc -\
parameters \ this is one page
usage /
sample -/
.....
string::Find() <short desc>
............
image
.....
My idea is :
1) Set up skeleton like this
2) Set up a public svn repository
3) When my svn class would be integrated on ide, use it to
extend documentation.
So, if I need something, and I don't find doc, I can add it on the fly (after searching inside upp code, maybe...).
That would be quite few effort to do like this... and docs could grow fast. After adding, just an <update svn doc> button and that would be available to all.
Your parser stuff it is important but also can be separated from it. It's needed for completion, to update doc skeleton and to quick locate stuffs from code inside docs, but it can be made independent from docs itself.
Ciao
Max
|
|
|
|
|
Documentation and Topic++
By: mirek on Tue, 13 November 2007 19:41
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Wed, 14 November 2007 11:46
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Wed, 14 November 2007 13:41
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Fri, 16 November 2007 12:05
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Tue, 04 December 2007 17:10
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Tue, 04 December 2007 23:32
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Wed, 05 December 2007 19:18
|
|
|
Re: Documentation and Topic++
By: Novo on Thu, 06 December 2007 20:05
|
|
|
Re: Documentation and Topic++
By: zsolt on Thu, 06 December 2007 21:05
|
|
|
Re: Documentation and Topic++
By: mirek on Thu, 06 December 2007 21:10
|
|
|
Re: Documentation and Topic++
By: Novo on Thu, 06 December 2007 21:49
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Thu, 13 December 2007 18:27
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Fri, 14 December 2007 17:17
|
|
|
Re: Documentation and Topic++
By: mrjt on Mon, 14 April 2008 11:27
|
|
|
Re: Documentation and Topic++
By: mirek on Mon, 14 April 2008 14:26
|
|
|
Re: Documentation and Topic++
By: mrjt on Mon, 14 April 2008 14:40
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Tue, 10 June 2008 18:35
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Thu, 12 June 2008 17:36
|
|
|
Re: Documentation and Topic++
By: zsolt on Thu, 12 June 2008 20:25
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mrjt on Thu, 12 June 2008 23:35
|
|
|
Re: Documentation and Topic++
By: mirek on Fri, 13 June 2008 09:36
|
|
|
Re: Documentation and Topic++
By: mirek on Fri, 13 June 2008 09:45
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Mon, 16 June 2008 13:00
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Mon, 16 June 2008 15:34
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Mon, 16 June 2008 19:38
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Wed, 18 June 2008 11:23
|
|
|
Re: Documentation and Topic++
By: mr_ped on Wed, 18 June 2008 11:39
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Mon, 16 June 2008 20:54
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Tue, 17 June 2008 00:55
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Wed, 18 June 2008 11:20
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Wed, 18 June 2008 13:22
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Wed, 18 June 2008 17:43
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Thu, 19 June 2008 15:00
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Sun, 06 July 2008 20:06
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Mon, 07 July 2008 22:15
|
|
|
Re: Documentation and Topic++
|
|
|
Re: Documentation and Topic++
By: mirek on Tue, 08 July 2008 16:11
|
|
|
Re: Documentation and Topic++
By: mirek on Tue, 08 July 2008 18:11
|
|
|
Re: Documentation and Topic++
By: mr_ped on Tue, 17 June 2008 11:59
|
|
|
Re: Documentation and Topic++
By: mirek on Tue, 17 June 2008 13:40
|
Goto Forum:
Current Time: Mon May 13 14:01:33 CEST 2024
Total time taken to generate the page: 0.02910 seconds
|