U++ forum: Welcome to the forum

Status & Roadmap

Authors & License

Funding Ultimate++

Search on this site

Search in forums

Home » Community » Coffee corner » in code comments - doxygen

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: in code comments - doxygen [message #8088 is a reply to message #8075]

Tue, 06 February 2007 20:29

darrs is currently offline

darrs
Messages: 5
Registered: October 2006
Location: New Zealand

Promising Member

Another suggestion.

In the editor you could put a little "Topic++" button in the margin next to global declarations / definitions (I'm assuming Assist++ knows how to recognize these). Clicking that would pop-up a small UWord window to document that function / variable (etc). Hovering over the button could show a pop-up tool-tip with that documentation.

Notes:

a) TheIDE would automatically add a copy of the appropriate function/variable declaration to the start of the documentation.

b) The documentation would be added to the standard Topic++ page for that class / module. Viewing the class via normal Topic++ would show all the combined documentation.

c) Editing the documentation via the margin button would only show the documentation for that declaration / definition. A button in the pop up window would close the pop-up window, start normal Topic++ editor and jump to that declaration in the relevant file.

Cheers,
Darrin.

Report message to a moderator

Send a private message to this user

[Message index]

		in code comments - doxygen By: qwerty on Tue, 21 November 2006 12:24
		Re: in code comments - doxygen By: fallingdutch on Tue, 21 November 2006 18:58
		Re: in code comments - doxygen By: mirek on Tue, 21 November 2006 21:14
		Re: in code comments - doxygen By: Balage on Mon, 18 December 2006 19:23
		Re: in code comments - doxygen By: mirek on Mon, 18 December 2006 19:49
		Re: in code comments - doxygen By: Balage on Mon, 18 December 2006 20:09
		Re: in code comments - doxygen By: mirek on Mon, 18 December 2006 22:26
		Re: in code comments - doxygen By: mr_ped on Thu, 01 February 2007 18:27
		Re: in code comments - doxygen By: mirek on Mon, 05 February 2007 22:57
		Re: in code comments - doxygen By: mr_ped on Tue, 06 February 2007 10:11
		Re: in code comments - doxygen By: mirek on Tue, 06 February 2007 10:27
		Re: in code comments - doxygen By: darrs on Tue, 06 February 2007 20:29
		Re: in code comments - doxygen By: mirek on Tue, 06 February 2007 23:26
		Re: in code comments - doxygen By: fudadmin on Sat, 23 June 2007 03:20
		Re: in code comments - doxygen By: waxblood on Sat, 23 June 2007 07:12
		Re: in code comments - doxygen By: captainc on Mon, 04 August 2008 15:49
		Re: in code comments - doxygen By: mirek on Mon, 04 August 2008 17:05
		Re: in code comments - doxygen By: mr_ped on Tue, 06 February 2007 11:32

Previous Topic:	A Newbie Manual cum Tutorial?
Next Topic:	Ultimate++ Website Logo Text

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

PDF

]

Current Time: Tue May 14 00:12:59 CEST 2024

Total time taken to generate the page: 0.02569 seconds