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 #8075 is a reply to message #8074]

Tue, 06 February 2007 10:27

mirek is currently offline

mirek
Messages: 13980
Registered: November 2005

Ultimate Member

mr_ped wrote on Tue, 06 February 2007 04:11

luzr wrote on Mon, 05 February 2007 22:57

I would like to postpone the final judgement until we have new class browser with Topic++ integration.

IMHO it's not as much about what Topic++ *can* do.

It's simply the docs stored not in code, what is main problem.
So whenever you change code, you must run Topic++ to change the help, which will never (ok, with absolutely disciplined programmers it will work superb, but we live in real world) work as good as doxygen's comments which reside inside of the code itself.
Still any lazy programmer will break even doxygen documentation, but the the some-what lazy programmer (who's too lazy to launch Topic++ but not enough lazy to not change comment) will produce better results with doxygen-like approach.

So the Topic++ will be always 1 step behind doxygen on the low level documentation, unless you merge the best of both worlds i.e. add features into Topic++ which will analyze the code itself and extract the low level documentation directly from code and comments just like doxygen does.

Well, these arguments are considered and valid.

On the other side of equation there is comfort of Topic++ editor... I can have advanced WYSIWYG formatting, spell checking, pictures...

Mirek

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: Mon May 13 23:16:35 CEST 2024

Total time taken to generate the page: 0.02374 seconds