U++ forum: Welcome to the forum

Status & Roadmap

Authors & License

Funding Ultimate++

Search on this site

Search in forums

Home » Developing U++ » Documentation » T++ working

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

Return to the default flat view

Create a new topic

Submit Reply

Re: T++ working [message #19142 is a reply to message #19072]

Fri, 14 November 2008 21:34

cbpporter is currently offline

cbpporter
Messages: 1428
Registered: September 2007

Ultimate Contributor

I updated another bunch of documentation files. Nothing very interesting Smile

Smile

.

The only problem was String. String is extremely complicated and this makes it hard to document. If I maintain the current style with String and WString documented together, it makes the document more concise, but it leaves a lot of code without document references, making the little icons useless. String being so complicated should get all the help that it can get.

On the other hand, if I document them separately, the documentation becomes a little more redundant, but more items are documented.

I tried something experimental: I documented String as if were a normal class without that complex templated inheritance. Wstring will be documented with the same approach. And AString will be also documented as an interface that bridges between the two types. If a method appears in all 3 classes, like with Cat, the same documentation will be copied to String (String0 that is, but I left String0 undocumented as I considerate a private implementation detail), WString (WString0) and AString. This way if someone reads String code or documentation, all the info will be available. If someone browses over AString code, then again valid documentation will be available.

You can check it out in SVN. I left the old doc intact, but prepended it with a String doc. Let me know what you think about this approach. Another approach would be to allow a documentation to be linked to multiple definitions, but I would prefer to not further complicate A++.

Quote:

Also a question: what is with all the .tppi. files. They seem to be generated on the fly. And what about all.i. I also get the impression that those files should not be up on SVN.

I would still like to know the answer.

Report message to a moderator

Send a private message to this user

[Message index]

		T++ working By: mirek on Fri, 31 October 2008 15:24
		Re: T++ working By: mr_ped on Fri, 31 October 2008 16:57
		Re: T++ working By: chickenk on Fri, 31 October 2008 17:56
		Re: T++ working By: mirek on Fri, 31 October 2008 18:49
		Re: T++ working By: cbpporter on Fri, 31 October 2008 20:27
		Re: T++ working By: captainc on Fri, 31 October 2008 23:53
		Re: T++ working By: mirek on Sat, 01 November 2008 09:04
		Re: T++ working By: tojocky on Mon, 03 November 2008 08:19
		Re: T++ working By: mirek on Mon, 03 November 2008 10:38
		Re: T++ working By: tojocky on Mon, 03 November 2008 13:37
		Re: T++ working By: chickenk on Mon, 03 November 2008 14:14
		Re: T++ working By: mirek on Mon, 03 November 2008 15:45
		Re: T++ working By: chickenk on Mon, 03 November 2008 15:50
		Re: T++ working By: mirek on Mon, 03 November 2008 20:44
		Re: T++ working By: cbpporter on Thu, 06 November 2008 19:07
		Re: T++ working By: mirek on Thu, 06 November 2008 19:29
		Re: T++ working By: cbpporter on Fri, 07 November 2008 15:54
		Re: T++ working By: cbpporter on Fri, 07 November 2008 21:17
		Re: T++ working By: captainc on Fri, 07 November 2008 23:41
		Re: T++ working By: cbpporter on Sat, 08 November 2008 10:36
		Re: T++ working By: mirek on Sat, 15 November 2008 14:48
		Re: T++ working By: mirek on Sat, 08 November 2008 14:27
		Re: T++ working By: mdelfede on Sun, 09 November 2008 10:48
		Re: T++ working By: cbpporter on Fri, 14 November 2008 21:34
		Re: T++ working By: mirek on Sat, 15 November 2008 14:50
		Re: T++ working By: cbpporter on Wed, 19 November 2008 13:17
		Re: T++ working By: cbpporter on Wed, 19 November 2008 15:29
		Re: T++ working By: mirek on Wed, 19 November 2008 22:47
		Re: T++ working By: cbpporter on Thu, 20 November 2008 14:30
		Re: T++ working By: captainc on Fri, 21 November 2008 03:10
		Re: T++ working By: tojocky on Fri, 21 November 2008 07:34
		Re: T++ working By: cbpporter on Fri, 21 November 2008 15:41
		Re: T++ working By: cbpporter on Tue, 10 March 2009 18:59
		Re: T++ working By: mirek on Tue, 10 March 2009 22:40
		Re: T++ working By: cbpporter on Wed, 11 March 2009 12:01
		Re: T++ working By: cbpporter on Thu, 12 March 2009 11:56
		Re: T++ working By: mirek on Fri, 13 March 2009 09:35
		Re: T++ working By: cbpporter on Sat, 14 March 2009 09:55
		Re: T++ working By: mirek on Sat, 08 November 2008 14:24
		Re: T++ working By: mirek on Sat, 01 November 2008 09:03

Previous Topic:	Notes on using T++ (comment on singals)
Next Topic:	List of patterns to be explained in article

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

PDF

]

Current Time: Wed Aug 27 21:10:34 CEST 2025

Total time taken to generate the page: 0.08336 seconds