: Thursday, November 16, 2006 7:46 PM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Alexei's metric is interesting, but sometimes shows strange results
for pretty good docs, like for quite commented files:
0 verifier_8h.html
,
Nadya Morozova
-Original Message-
From: Alexei Fedotov [mailto:[EMAIL PROTECTED]
Sent: Thursday, November 16, 2006 8:48 PM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Andrey,
I'm trying to understand your metric and have
@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Alexei,
Metric is simply the number of Doxygen warnings for file. Sorry for
not mentioning this in my letter.
If some file doesn't have Doxygen comments at all then metric can show
only one problem, like in your
should be improved in DRLVM Doxygen
documentation?
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
PROTECTED]
Sent: Thursday, November 16, 2006 7:46 PM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Alexei's metric is interesting, but sometimes shows strange results
for pretty good docs, like for quite commented files:
0
@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Alexei's metric is interesting, but sometimes shows strange results
for pretty good docs, like for quite commented files:
0 verifier_8h.html
0 structVerifier_1_1vf__Graph.html
Seems like this metric likes big narrative
7:46 PM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Alexei's metric is interesting, but sometimes shows strange results
for pretty good docs, like for quite commented files:
0 verifier_8h.html
0 structVerifier_1_1vf__Graph.html
@incubator.apache.org
Subject: RE: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
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
Morozova
-Original Message-
From: Alexei Fedotov [mailto:[EMAIL PROTECTED]
Sent: Thursday, November 16, 2006 8:48 PM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Andrey,
I'm trying to understand your metric and have got
Mikhail,
Sorry, I'm a bit slow. From my perspective making a documentation
bundle from inter-component interfaces is an excellent idea! I started
collecting interfaces from vm/include directory.
Are there any other bundles a community is interested in? Being closer
to the point, let me ask if
,
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 DRLVM Doxygen
documentation?
Egor,
I
+1
Thank you,
Nadya Morozova
-Original Message-
From: news [mailto:[EMAIL PROTECTED] On Behalf Of Egor Pasko
Sent: Tuesday, November 07, 2006 11:23 AM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
On the 0x216 day
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 workaround,
On the 0x21A day of Apache Harmony Mikhail Fursov wrote:
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
On 07 Nov 2006 19:08:35 +0600, Egor Pasko [EMAIL PROTECTED] wrote:
Another problem: anyone who changes a document behaviour must update
comments too :(
excuse me, what is document behaviour? :)
Read it as 'method/function behaviour'. I mean if you have good comments in
file you can't
: [doc] What should be improved in DRLVM Doxygen
documentation?
On the 0x21A day of Apache Harmony Mikhail Fursov wrote:
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
On the 0x21A day of Apache Harmony Mikhail Fursov wrote:
On 07 Nov 2006 19:08:35 +0600, Egor Pasko [EMAIL PROTECTED] wrote:
Another problem: anyone who changes a document behaviour must update
comments too :(
excuse me, what is document behaviour? :)
Read it as 'method/function
On 07 Nov 2006 21:17:45 +0600, Egor Pasko [EMAIL PROTECTED] wrote:
Do we feel that it is time to set responsibilities on documenting
vm/include/* ?
+1 To start working on intercomponent interfaces. Going to commit a couple
of EM interface files with documentation tomorrow. I do not believe
PROTECTED]
Sent: Tuesday, November 07, 2006 4:30 PM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
On 07 Nov 2006 19:08:35 +0600, Egor Pasko [EMAIL PROTECTED] wrote:
Another problem: anyone who changes a document behaviour must
Egor,
Thank you for your interest. Here is an algorithm:
1. Create a list of words from HTML files.
2. Merge a dictionary of all words used in documentation.
3. Remove a half of the most frequently used words from the dictionary
- I believe they do not add much sense.
4. Remove misspelled words
On the 0x216 day of Apache Harmony Alexei Fedotov wrote:
Egor,
Thank you for your interest.
We definitely need to improve our documentation. Necessity is not a
real interest :)
Here is an algorithm:
1. Create a list of words from HTML files.
2. Merge a dictionary of all words used in
Subject: [doc] What should be improved in DRLVM Doxygen documentation?
Nadya, All,
I have ranked the quality of Doxygen-generated DRLVM documentation and
posted it to the following Wiki page:
http://wiki.apache.org/harmony/DRLVM_Documentation_Quality
All are welcome to check masterpieces
, Alexei A [mailto:[EMAIL PROTECTED]
Sent: Thursday, November 02, 2006 11:33 PM
To: harmony-dev@incubator.apache.org
Subject: [doc] What should be improved in DRLVM Doxygen documentation?
Nadya, All,
I have ranked the quality of Doxygen-generated DRLVM documentation and
posted it to the following
be improved in DRLVM Doxygen documentation?
Nadya, All,
I have ranked the quality of Doxygen-generated DRLVM documentation and
posted it to the following Wiki page:
http://wiki.apache.org/harmony/DRLVM_Documentation_Quality
All are welcome to check masterpieces of our documentation. All
Egor,
I pursued a requirement to compare HTML documents of a different
nature. For this requirement comparing a number of documented items vs
not documented ones doesn't work. For source files your metrics is the
best.
Let me comment on unique words. The goal was to subtract words like
Great to hear that! Let me know if you need help.
Thank you,
Nadya Morozova
-Original Message-
From: Leviev, Ilia A [mailto:[EMAIL PROTECTED]
Sent: Friday, November 03, 2006 3:35 PM
To: harmony-dev@incubator.apache.org
Subject: RE: [doc] What should be improved in DRLVM Doxygen
Nadya,
It is excellent! Thank you.
Best regards,
Leviev Ilia
-Original Message-
From: Morozova, Nadezhda [mailto:[EMAIL PROTECTED]
Sent: Friday, November 03, 2006 5:14 PM
To: harmony-dev@incubator.apache.org
Subject: RE: [doc] What should be improved in DRLVM Doxygen
documentation
opinion.
Thank you,
Nadya Morozova
-Original Message-
From: news [mailto:[EMAIL PROTECTED] On Behalf Of Egor Pasko
Sent: Friday, November 03, 2006 12:18 PM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
On the 0x216 day
[mailto:[EMAIL PROTECTED]
Sent: Friday, November 03, 2006 1:56 AM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Nadya,
You asked good questions. Here are few answers:
1. Grouping of results is implied by documentation grouping
Fedotov [mailto:[EMAIL PROTECTED]
Sent: Friday, November 03, 2006 11:27 AM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Egor,
Thank you for your interest. Here is an algorithm:
1. Create a list of words from HTML files.
2. Merge
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 DRLVM Doxygen
documentation?
Egor,
I
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.apache.org
Subject: RE: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Nadya wrote,
we could check
[mailto:[EMAIL PROTECTED]
Sent: Friday, November 03, 2006 1:56 AM
To: harmony-dev@incubator.apache.org
Subject: Re: [doc] What should be improved in DRLVM Doxygen
documentation?
Nadya,
You asked good questions. Here are few answers:
1. Grouping of results is implied by documentation grouping
Nadya, All,
I have ranked the quality of Doxygen-generated DRLVM documentation and
posted it to the following Wiki page:
http://wiki.apache.org/harmony/DRLVM_Documentation_Quality
All are welcome to check masterpieces of our documentation. All
volunteers are welcome to improve page ranks by
volunteer to help.
Thank you,
Nadya Morozova
-Original Message-
From: Fedotov, Alexei A [mailto:[EMAIL PROTECTED]
Sent: Thursday, November 02, 2006 11:33 PM
To: harmony-dev@incubator.apache.org
Subject: [doc] What should be improved in DRLVM Doxygen documentation?
Nadya, All,
I have
]
Sent: Thursday, November 02, 2006 11:33 PM
To: harmony-dev@incubator.apache.org
Subject: [doc] What should be improved in DRLVM Doxygen documentation?
Nadya, All,
I have ranked the quality of Doxygen-generated DRLVM documentation and
posted it to the following Wiki page:
http://wiki.apache.org
: Thursday, November 02, 2006 11:33 PM
To: harmony-dev@incubator.apache.org
Subject: [doc] What should be improved in DRLVM Doxygen documentation?
Nadya, All,
I have ranked the quality of Doxygen-generated DRLVM documentation and
posted it to the following Wiki page:
http
37 matches
Mail list logo
