Mindtraveller Messages: 917 Registered: August 2007 Location: Russia, Moscow rgn.
Experienced Contributor
Novo, so the only working scenario is a remote development with X+SSH on *nix systems connected via modem? I`d say it is rather unfrequent scenario. Should we really consider such a problem instead of i.e. developers using better connections? This would really lead to global rewrite of GUI libs.
Besides, I do develop for platforms with neither graphics nor attribute support. Just (ANSI) terminal with minimum available RAM (< 1 Mb). Should I request U++ support for such minimalistic platforms too?
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)
Just for the record so the next time I do not have to reinvent this list:
- documenting a set of methods with single description (e.g. overloaded variants of the same thing, like DrawText), T++ is more flexible.
- putting comments into the code would practically disabled possibility to define inline methods within class (see all those simle modifier methods like EditField::Password).