U++ framework: Documentation » Documentation how-to...

Home » Developing U++ » Documentation » Documentation how-to...

Show: Today's Messages :: Polls :: Message Navigator
E-mail to friend

Re: Documentation how-to... [message #17968 is a reply to message #17967]

Thu, 04 September 2008 22:59

cbpporter
Messages: 1428
Registered: September 2007

Ultimate Contributor

captainc wrote on Thu, 04 September 2008 23:20

Write it in open office and post it here. I'll format it and upload to svn. We just need to get the stuff written down; we cannot wait till T++ is perfect.

I might just do that for now, but I wouldn't want to have someone do the hard work, when the computer is perfectly capable of doing it (or it will be someday Smile

).

So I thought that for starters we should settle on a style. I posted 3 different styles. Such styling should definitely be handled one day by Topic++ without me going in and editing the file. First style is the classic one, used in documentation. The second is something more like I would like to have, but there is still a lot of tweaking. This style maybe should be updated to the JavaDoc style. I like this style and with slight tweaks could be made more C++ friendly. Third is a variant of two.

These are just samples. If anybody has any great ideas, please post a mock-up. But I think that the classical flat style, with a bunch of text just thrown at you must go.

Attachment: 01.pdf
(Size: 83.88KB, Downloaded 697 times)

Report message to a moderator

[Message index]

		Documentation how-to... By: mirek on Fri, 22 August 2008 13:45
		Re: Documentation how-to... By: captainc on Fri, 22 August 2008 13:54
		Re: Documentation how-to... By: mirek on Wed, 27 August 2008 10:49
		Re: Documentation how-to... By: captainc on Wed, 27 August 2008 18:43
		Re: Documentation how-to... By: mirek on Wed, 27 August 2008 23:51
		Re: Documentation how-to... By: cbpporter on Thu, 04 September 2008 10:32
		Re: Documentation how-to... By: mirek on Thu, 04 September 2008 13:25
		Re: Documentation how-to... By: cbpporter on Thu, 04 September 2008 14:00
		Re: Documentation how-to... By: cbpporter on Thu, 04 September 2008 14:43
		Re: Documentation how-to... By: mr_ped on Thu, 04 September 2008 15:29
		Re: Documentation how-to... By: cbpporter on Thu, 04 September 2008 21:51
		Re: Documentation how-to... By: mirek on Thu, 04 September 2008 22:04
		Re: Documentation how-to... By: cbpporter on Thu, 04 September 2008 22:15
		Re: Documentation how-to... By: captainc on Thu, 04 September 2008 22:20
		Re: Documentation how-to... By: cbpporter on Thu, 04 September 2008 22:59
		Re: Documentation how-to... By: cbpporter on Thu, 04 September 2008 23:00
		Re: Documentation how-to... By: cbpporter on Thu, 04 September 2008 23:02
		Re: Documentation how-to... By: captainc on Fri, 05 September 2008 01:32
		Re: Documentation how-to... By: mirek on Fri, 05 September 2008 10:06
		Re: Documentation how-to... By: cbpporter on Fri, 05 September 2008 13:32
		Re: Documentation how-to... By: mirek on Fri, 05 September 2008 14:17
		Re: Documentation how-to... By: cbpporter on Fri, 05 September 2008 14:20
		Re: Documentation how-to... By: mirek on Fri, 05 September 2008 00:35
		Re: Documentation how-to... By: mirek on Sun, 07 September 2008 13:38
		Re: Documentation how-to... By: mirek on Sun, 07 September 2008 13:51
		Re: Documentation how-to... By: cbpporter on Tue, 09 September 2008 05:10
		Re: Documentation how-to... By: captainc on Tue, 09 September 2008 13:10
		Re: Documentation how-to... By: mirek on Tue, 09 September 2008 13:37
		Re: Documentation how-to... By: cbpporter on Wed, 10 September 2008 05:34
		Re: Documentation how-to... By: cbpporter on Thu, 18 September 2008 05:06
		Re: Documentation how-to... By: mirek on Thu, 18 September 2008 18:28
		Re: Documentation how-to... By: mirek on Sun, 21 September 2008 09:46
		Re: Documentation how-to... By: cbpporter on Sun, 21 September 2008 10:07
		Re: Documentation how-to... By: mirek on Sun, 21 September 2008 10:51
		Re: Documentation how-to... By: cbpporter on Sun, 21 September 2008 11:38
		Re: Documentation how-to... By: mirek on Sun, 21 September 2008 11:59
		Re: Documentation how-to... By: mirek on Mon, 22 September 2008 18:37
		Re: Documentation how-to... By: cbpporter on Tue, 23 September 2008 18:53
		Re: Documentation how-to... By: mirek on Tue, 23 September 2008 19:43
		Re: Documentation how-to... By: mirek on Thu, 04 September 2008 22:00
		Re: Documentation how-to... By: mr_ped on Fri, 05 September 2008 15:10
		Re: Documentation how-to... By: captainc on Fri, 05 September 2008 15:47
		Re: Documentation how-to... By: cbpporter on Fri, 05 September 2008 16:52
		Re: Documentation how-to... By: captainc on Fri, 05 September 2008 17:15
		Re: Documentation how-to... By: cbpporter on Fri, 05 September 2008 18:11
		Re: Documentation how-to... By: cbpporter on Fri, 05 September 2008 20:29
		Re: Documentation how-to... By: mirek on Fri, 05 September 2008 20:35
		Re: Documentation how-to... By: cbpporter on Fri, 05 September 2008 20:37
		Re: Documentation how-to... By: captainc on Fri, 05 September 2008 20:59
		Re: Documentation how-to... By: cbpporter on Sat, 06 September 2008 21:05
		Re: Documentation how-to... By: mirek on Sat, 06 September 2008 21:17
		Re: Documentation how-to... By: mirek on Sun, 07 September 2008 08:59
		Re: Documentation how-to... By: mirek on Sun, 07 September 2008 09:00
		Re: Documentation how-to... By: cbpporter on Sun, 07 September 2008 09:20
		Re: Documentation how-to... By: mirek on Sun, 07 September 2008 10:00
		Re: Documentation how-to... By: mirek on Sun, 07 September 2008 10:06
		Re: Documentation how-to... By: mirek on Sun, 07 September 2008 10:13
		Re: Documentation how-to... By: mirek on Fri, 05 September 2008 20:53
		Re: Documentation how-to... By: cbpporter on Fri, 05 September 2008 20:59
		Re: Documentation how-to... By: Oblivion on Mon, 06 October 2008 21:03
		Re: Documentation how-to... By: captainc on Thu, 09 October 2008 21:23
		Re: Documentation how-to... By: mirek on Thu, 09 October 2008 23:26

Previous Topic:	The very first taste of T++ icons in the left bar..
Next Topic:	Notes on using T++ (comment on singals)

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Sun Aug 02 11:35:05 GMT+2 2026

Total time taken to generate the page: 0.01509 seconds