U++ forum: Welcome to the forum

Status & Roadmap

Authors & License

Funding Ultimate++

Search on this site

Search in forums

Home » Developing U++ » U++ Developers corner » Documentation and Topic++

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: Documentation and Topic++ [message #12728 is a reply to message #12727]

Wed, 14 November 2007 13:41

mirek is currently offline

mirek
Messages: 13979
Registered: November 2005

Ultimate Member

Mindtraveller wrote on Wed, 14 November 2007 07:24

Quote:

Mostly agree, but I think medium advanced user will need to know those magic words too, so that he can use Topic++ to write docs...

One of ideas is that browsing the .h file, you will have small icons in left bar (when breakpoints usually are) for each code element (e.g. method declaration); moving the mouse over that icon will popup documentation for the item.

If documentation is not available for item, icon will look differently and clicking it will move you to topic++, generating the text template to document the method.

Similar capabilities should be available in new class browser too.

In .cpp, the idea is that instead of "src", these will lead to "srcimp".

Could you please describe why exactly is it needed to use these words? I think it is way too hard for understanding "by default". Yes, user may learn manual on that subject, but what for?
It`s nothing prevents us from adding these comments simply by clicking left icon and typing docs in the same window, without any additional identifiers. For me it is so natural, that I have to think of arguments to make this thought clear.

Well, if nothing else, groups are important if you are importing Topic++ into your code - you do so by package-group quantities.

So perhaps for documenting the code, you could do without it, but for using Topic++ as application document resources, understanding of groups is unavoidable.

Mirek

Report message to a moderator

Send a private message to this user

[Message index]

		Documentation and Topic++ By: mirek on Tue, 13 November 2007 19:41
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 14 November 2007 04:32
		Re: Documentation and Topic++ By: mirek on Wed, 14 November 2007 11:46
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 14 November 2007 13:24
		Re: Documentation and Topic++ By: mirek on Wed, 14 November 2007 13:41
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:36
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:37
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:40
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:42
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 16 November 2007 01:54
		Re: Documentation and Topic++ By: mirek on Fri, 16 November 2007 12:05
		Re: Documentation and Topic++ By: Mindtraveller on Tue, 04 December 2007 16:21
		Re: Documentation and Topic++ By: mirek on Tue, 04 December 2007 17:10
		Re: Documentation and Topic++ By: Mindtraveller on Tue, 04 December 2007 19:25
		Re: Documentation and Topic++ By: mirek on Tue, 04 December 2007 23:32
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 05 December 2007 18:19
		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++ By: Mindtraveller on Wed, 12 December 2007 23:20
		Re: Documentation and Topic++ By: mirek on Thu, 13 December 2007 18:27
		Re: Documentation and Topic++ By: Mindtraveller on Fri, 14 December 2007 05:57
		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++ By: cbpporter on Tue, 10 June 2008 17:13
		Re: Documentation and Topic++ By: mirek on Tue, 10 June 2008 18:35
		Re: Documentation and Topic++ By: cbpporter on Thu, 12 June 2008 13:02
		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++ By: cbpporter on Thu, 12 June 2008 22:46
		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++ By: Mindtraveller on Sun, 15 June 2008 14:59
		Re: Documentation and Topic++ By: mdelfede on Sun, 15 June 2008 19:03
		Re: Documentation and Topic++ By: Mindtraveller on Sun, 15 June 2008 21:26
		Re: Documentation and Topic++ By: mirek on Mon, 16 June 2008 13:00
		Re: Documentation and Topic++ By: mdelfede on Mon, 16 June 2008 13:58
		Re: Documentation and Topic++ By: mirek on Mon, 16 June 2008 15:34
		Re: Documentation and Topic++ By: cbpporter on Mon, 16 June 2008 17:21
		Re: Documentation and Topic++ By: mirek on Mon, 16 June 2008 19:38
		Re: Documentation and Topic++ By: cbpporter on Wed, 18 June 2008 10:30
		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++ By: Mindtraveller on Mon, 16 June 2008 20:48
		Re: Documentation and Topic++ By: mirek on Mon, 16 June 2008 20:54
		Re: Documentation and Topic++ By: mdelfede on Mon, 16 June 2008 23:12
		Re: Documentation and Topic++ By: mirek on Tue, 17 June 2008 00:55
		Re: Documentation and Topic++ By: mdelfede on Tue, 17 June 2008 01:02
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 18 June 2008 09:16
		Re: Documentation and Topic++ By: mdelfede on Wed, 18 June 2008 09:55
		Re: Documentation and Topic++ By: mirek on Wed, 18 June 2008 11:20
		Re: Documentation and Topic++ By: mdelfede on Wed, 18 June 2008 12:05
		Re: Documentation and Topic++ By: mirek on Wed, 18 June 2008 13:22
		Re: Documentation and Topic++ By: Mindtraveller on Wed, 18 June 2008 14:42
		Re: Documentation and Topic++ By: mdelfede on Wed, 18 June 2008 16:29
		Re: Documentation and Topic++ By: mirek on Wed, 18 June 2008 17:43
		Re: Documentation and Topic++ By: Mindtraveller on Thu, 19 June 2008 13:26
		Re: Documentation and Topic++ By: mirek on Thu, 19 June 2008 15:00
		Re: Documentation and Topic++ By: Mindtraveller on Sun, 06 July 2008 09:45
		Re: Documentation and Topic++ By: mirek on Sun, 06 July 2008 20:06
		Re: Documentation and Topic++ By: captainc on Mon, 07 July 2008 19:37
		Re: Documentation and Topic++ By: mirek on Mon, 07 July 2008 22:15
		Re: Documentation and Topic++ By: captainc on Tue, 08 July 2008 14:06
		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

Previous Topic:	Task: How to read GTK/Gnome settings
Next Topic:	U++ infrastructure server...

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

PDF

]

Current Time: Mon May 13 11:32:53 CEST 2024

Total time taken to generate the page: 0.04597 seconds