harmony-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Alexei Fedotov" <alexei.fedo...@gmail.com>
Subject Re: [doc] What should be improved in DRLVM Doxygen documentation?
Date Fri, 03 Nov 2006 08:27:00 GMT

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 (including identifiers) from the dictionary.
5. Give a page +1 for each rare, correctly spelled word according to
the dictionary.
6. Divide to the total number of words on the page.

I've collected nice RFEs from your letter. Most of them make me think
and I like them.
a. Update an ASF block comment
b. Improve readability. Some things are really easy - like removing
awk and rewriting most things in perl. Others are a bit more complex -
I targeted script performance when created auto-generated perl script.
Also, initial algorithm was a bit more complex - different words had a
different cost based on their popularity.
c. Use junit test output format to integrate with
http://harmonytest.org. I believe I need a feature request for that
site as well - we need some way to import performance-like rankings to
the site.
d. I will think of parsing sources. But I don't think we need to
maintain both scripts. The generic rule is simple - improve your .h
and .java files - .cpp files don't count. I suggest better to link
.html files to contributors.

Thank you for ideas. I will certainly update the script. I just want
to wait a bit - many scripts die just because people are not
interested to run them a second time. Also, if anyone suggest any
changes in algorithm or any other RFEs, I want to implement them all
at once.

Nadya, could you please point us a good documentation file so we can
use it as a pattern?

-- Alexei

View raw message