Re: My impression of ROOT Automatic Document Generation
Jacek M. Holeczek (holeczek@clri6g.gsi.de)
Fri, 27 Jun 1997 17:17:15 +0200 (EET)
I think there is a small mis-understanding here.
You both are taking about something called "documentation", but for me it
seems that you are talking about different ( although related ) things :
1. Nenad Buncic talks about end-user documentation which is
expected to give brief descriptions of classes, functions, ...
For this purpose the current "ROOTdoc" is quite o.k.. .
2. Terrence Brannon talks more about "source code" "documentation"
for developers, and that's something completely different.
This includes, of course, the end-user documentation, but there
could ( should ) be a lot more ... . I also think that adding
"folding" "stubs" to root sources is really a good idea.
I hope here, that you all know what means a "folding" editor, for example
the standard "outline" + "foldout" modes in emacs ( there are others, for
example out-xtra.el, foldingo.el, folding.el, c-outline.el, ... ). And it
is not true that one needs to "invent special language and I force you to
change your existing 300,000 lines of code". For example the "out-xtra.el"
works using indention, thus using a well formated code ( there is a very
good c/c++ mode for emacs called cc-mode.el ) it should be easy ... .
Jacek.
P.S. Add highliting ( "font-lock" ) and ... you have everything in colors.
( I haven't heard about adding "music" to emacs, but ... . ) Jacek.