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 » U++ talk

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: Does the provided upp.spec works for you and on which distro? [message #17901 is a reply to message #17899]

Tue, 02 September 2008 14:29

mirek is currently offline

mirek
Messages: 14267
Registered: November 2005

Ultimate Member

cbpporter wrote on Tue, 02 September 2008 08:19

Doxygen: I'm all for reusing technology which works (i.e. doxygen) and wouldn't mind using it instead of Topic++. Topic may be more intimately tied to A++, but I don't think this mattes that much since docs are not autogenerated.

And docs are coming along Smile

Smile

.

Do not forget one small practical issue. With doxygen style docs, people need write access to trunk code to edit documentation.

Meanwhile, separate .tpp directories do not present any danger to the code. Broken docs is something fixed easily. But I would not want to have deployed broken app because somebody accidentally damaged the code when working on docs.

Means, we can allow much more people to edit docs with T++...

That said, I had and have really hard time deciding this (T++ vs doxygen). This is not a new issue, I was at it since the very beginning.

I see the pros/cons:

Doxygen pros:
- known standard tool that works
- not much work required (except moving doc back from T++)
- very thight integration with code (because it is in the code)

cons:
- needs write access to the code to document it
- hard to put images into docs
- harder to put "explanation passages" (because the document structure is fixed)

T++ pros:
- separate docs with separate write rights
- comfortable wordprocessor with spelling checker
- no problem screenshotting widgets and putting images
- same environment to create code reference docs ("src") and explanation/tutorial docs ("srcdoc")
- possible to add implementation articles

cons:
- "invented here"
- a lot of work programming it (but, we need some of it anyway)

(I might have forgoten something)

Mirek

Mirek

[Updated on: Tue, 02 September 2008 14:38]

Report message to a moderator

Send a private message to this user

[Message index]

		U++ talk By: amrein on Mon, 01 September 2008 14:43
		Re: Does the provided upp.spec works for you and on which distro? By: cbpporter on Mon, 01 September 2008 15:00
		Re: Does the provided upp.spec works for you and on which distro? By: guido on Mon, 01 September 2008 23:32
		Re: Does the provided upp.spec works for you and on which distro? By: amrein on Tue, 02 September 2008 11:38
		Re: Does the provided upp.spec works for you and on which distro? By: mirek on Tue, 02 September 2008 14:22
		Re: Does the provided upp.spec works for you and on which distro? By: mirek on Tue, 02 September 2008 10:06
		Re: Does the provided upp.spec works for you and on which distro? By: amrein on Tue, 02 September 2008 12:45
		Re: Does the provided upp.spec works for you and on which distro? By: mirek on Tue, 02 September 2008 13:53
		Re: Does the provided upp.spec works for you and on which distro? By: mirek on Tue, 02 September 2008 14:17
		Re: Does the provided upp.spec works for you and on which distro? By: cbpporter on Tue, 02 September 2008 14:19
		Re: Does the provided upp.spec works for you and on which distro? By: mirek on Tue, 02 September 2008 14:29
		Re: Does the provided upp.spec works for you and on which distro? By: captainc on Tue, 02 September 2008 16:22
		Re: Does the provided upp.spec works for you and on which distro? By: mirek on Wed, 10 September 2008 19:26
		Re: Does the provided upp.spec works for you and on which distro? By: mirek on Wed, 03 September 2008 09:49
		Re: U++ talk By: amrein on Tue, 02 September 2008 20:47
		Re: U++ talk By: mirek on Tue, 02 September 2008 21:23
		Re: U++ talk By: mirek on Tue, 02 September 2008 21:24
		Re: U++ talk By: amrein on Tue, 02 September 2008 22:20
		Re: U++ talk By: mirek on Tue, 02 September 2008 23:20
		Re: U++ talk By: cbpporter on Tue, 02 September 2008 22:30
		Re: U++ talk By: mirek on Tue, 02 September 2008 23:22
		Re: U++ talk By: amrein on Tue, 02 September 2008 23:37
		Re: U++ talk By: captainc on Wed, 03 September 2008 03:44
		Re: U++ talk By: mirek on Wed, 03 September 2008 09:58
		Re: U++ talk By: cbpporter on Wed, 03 September 2008 10:23
		Re: U++ talk By: mirek on Wed, 03 September 2008 11:10
		Re: U++ talk By: amrein on Wed, 03 September 2008 18:52
		Re: U++ talk By: mirek on Wed, 03 September 2008 22:55
		Re: U++ talk By: mirek on Wed, 03 September 2008 23:00
		Re: U++ talk By: cbpporter on Thu, 04 September 2008 04:52
		Re: U++ talk By: mr_ped on Thu, 04 September 2008 09:30
		Re: U++ talk By: mirek on Thu, 04 September 2008 12:45
		Re: U++ talk By: amrein on Thu, 04 September 2008 13:41
		Re: U++ talk By: mirek on Thu, 04 September 2008 21:55
		Re: U++ talk By: amrein on Thu, 04 September 2008 13:38
		Re: U++ talk By: mirek on Thu, 04 September 2008 21:54
		Re: U++ talk By: amrein on Thu, 04 September 2008 23:06
		Re: U++ talk By: amrein on Thu, 04 September 2008 23:28
		Re: U++ talk By: Mindtraveller on Sun, 07 September 2008 23:34
		Re: U++ talk By: Novo on Mon, 08 September 2008 05:01
		Re: U++ talk By: mirek on Mon, 08 September 2008 08:23
		Re: U++ talk By: Mindtraveller on Mon, 08 September 2008 09:22
		Re: U++ talk By: mr_ped on Mon, 08 September 2008 11:16

Previous Topic:	Assist - rescan code vs caching in files....
Next Topic:	Upp Idea -> MultiTouch support

Goto Forum:

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

PDF

]

Current Time: Sun Aug 24 20:22:11 CEST 2025

Total time taken to generate the page: 0.05091 seconds