RE: Re: [doc] What should be improved in DRLVM Doxygen documentation?

2006-11-07 Thread Morozova, Nadezhda
+1. Doxygen has a @todo tag that we can use. Quote from manual: \todo { paragraph describing what is to be done } Starts a paragraph where a TODO item is described. The description will also add an item to a separate TODO list. The two instances of the description will be cross-referenced. Each ite

Re: Re: [doc] What should be improved in DRLVM Doxygen documentation?

2006-11-07 Thread Mikhail Fursov
On 11/7/06, Morozova, Nadezhda <[EMAIL PROTECTED]> wrote: +1 "For in much wisdom is much grief: and he that increaseth knowledge increaseth sorrow" I'm also +1 to document all of our sources. But it's not always possible to write a meaningful comment without a lot of "TODO", "this is a worka

RE: Re: [doc] What should be improved in DRLVM Doxygen documentation?

2006-11-07 Thread Morozova, Nadezhda
to document sources better. Or it is too much effort? > With best regards, > Alexei Fedotov, > Intel Java & XML Engineering > > >-Original Message- > >From: Morozova, Nadezhda [mailto:[EMAIL PROTECTED] > >Sent: Friday, November 03, 2006 6:26 P

RE: Re: [doc] What should be improved in DRLVM Doxygen documentation?

2006-11-03 Thread Fedotov, Alexei A
tion comment. >Never mind, I think this type of info is not necessary at this stage:) > >Thank you, >Nadya Morozova > > >-Original Message- >From: Fedotov, Alexei A [mailto:[EMAIL PROTECTED] >Sent: Friday, November 03, 2006 7:36 PM >To: harmony-dev@incubator.a

RE: Re: [doc] What should be improved in DRLVM Doxygen documentation?

2006-11-03 Thread Morozova, Nadezhda
stage:) Thank you, Nadya Morozova -Original Message- From: Fedotov, Alexei A [mailto:[EMAIL PROTECTED] Sent: Friday, November 03, 2006 7:36 PM To: harmony-dev@incubator.apache.org Subject: RE: Re: [doc] What should be improved in DRLVM Doxygen documentation? Nadya wrote, > we could c

RE: Re: [doc] What should be improved in DRLVM Doxygen documentation?

2006-11-03 Thread Fedotov, Alexei A
ce With best regards, Alexei Fedotov, Intel Java & XML Engineering >-Original Message- >From: Morozova, Nadezhda [mailto:[EMAIL PROTECTED] >Sent: Friday, November 03, 2006 6:26 PM >To: harmony-dev@incubator.apache.org >Subject: RE: Re: [doc] What should be improved in D

RE: Re: [doc] What should be improved in DRLVM Doxygen documentation?

2006-11-03 Thread Morozova, Nadezhda
Egor, I agree with you on the idea of simplicity: documented vs. non-documented. An additional point: do you think we need/want to evaluate quality of comments? we could check for required Doxygen tags in certain elements. For example, a function is almost certain to include @param and @return. S