Home » Developing U++ » U++ Developers corner » Documentation and Topic++
Re: Documentation and Topic++ [message #16451 is a reply to message #16450] |
Mon, 16 June 2008 15:34 |
|
mirek
Messages: 13979 Registered: November 2005
|
Ultimate Member |
|
|
mdelfede wrote on Mon, 16 June 2008 07:58 |
luzr wrote on Mon, 16 June 2008 13:00 | Well, before going further into details, I guess we should consider:
- how much effort we are really able to put into it
|
Well, that depends on how comfortable are instruments to do it.
IMHO in current help engine, most of time is spent formatting documentation rather than documenting code.... Something to just write stuffs and that does automatically (and uniform) formatting would be of great help.
Quote: |
- how much of it can be automated. E.g. IMO, that nice mockup posted a while ago can be fully generated using current Topic++ scheme
|
That depends also on tools. I don't know (I didn't go too in depth on it) if topic++ scheme can store as many information as needed and if it's easy to parse as xml. If so, we could easily separate data structure from viewer.
|
Topic++ stores reference points for all documented code entities - code items (methods, variables etc). It is easy to get document and place in the document for specific code item.
This is complemented (or should be with ability to parse C++ and actually get the complete list of all these code items. IMO, with these two systems should give you ability to produce some pretty nice results...
Mirek
|
|
|
|
|
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 12:18:27 CEST 2024
Total time taken to generate the page: 0.03388 seconds
|