This page gathers information on the current state and improvement progress for documentation autogenerated from DRLVM sources. You can view the current autogenerated documentation posted at Doxygen Starting page on our website. You can also regenerate the docs by parses local copies of source files (follow the same link for instructions).
This section displays indicators for the quantity and quality of current autogenerated documentation.
This metric reflects the completion of documentation: scans resulting HTML documentation pages for each component, rates each page per doc completeness, and calculates the percentage of well-documented HTML pages.
|
Generated html files |
|
|
Comments |
|
Bundle |
Documented |
Total |
Completion |
|
|
Inter-component interfaces |
76 |
267 |
29% |
Q decrease 5%, increase in total file N(+56) |
|
Execution manager |
15 |
44 |
36% |
no change |
|
Copying/compacting GC |
8 |
35 |
23% |
no change |
|
Generational GC |
7 |
41 |
16% |
Q increase 1%, reduction in total file N(-3) |
|
Interpreter |
16 |
26 |
62% |
Q increase 19% |
|
Jitrino |
15 |
59 |
28% |
no change |
|
Porting layer |
44 |
163 |
28% |
Q decrease 1%, increase in total file N |
|
Thread manager |
14 |
37 |
38% |
no change |
|
VM core |
72 |
542 |
14% |
no change |
|
Class library support |
6 |
9 |
66% |
Q increase 6%, 1 undoc file less |
|
Component manager |
10 |
23 |
43% |
Q decrease 1%, 1 undoc file less |
|
Average |
24 |
114 |
21% |
Q increase 5%, reduction in total file N |
last update: 02-06-2008 this update measures against April'07 to show slow H2'07 progress
You can get the results for yourself. Generate documentation and run the scripts over it:
convert_html_to_list
call at the end of sh check_doc_quality.sh
sh check_doc_quality.sh <documentation directory>
doc_quality/result.txt
The quality of comments in source files is measured by means of CCCC tool. See the attached cccc.html for a list of all scanned files and their quality. Red and yellow boxes represent entities with poor comments. Some fields have dashes instead of numbers, which means the tool has failed to estimate the quality. Check here for unabridged CCCC output.
We're planning to generate shorted ratings for DRLVM external interfaces and for VM core interfaces.
To rank the resulting HTML documentation for the Quantity Metric, do the following:
Here we note the healthiness of generated docs by noting the amount of logged warnings and errors during doc generation. Things to note about this measurement:
Bundle |
State |
Comment |
Inter-component interfaces |
yellow |
some warnings |
Execution manager |
N/A |
|
Copying/compacting GC |
green |
almost none |
Generational GC |
green |
almost none |
Interpreter |
green |
almost none |
Jitrino |
green |
almost none |
Porting layer |
green |
almost none |
Thread manager |
green |
almost none |
VM core |
red |
many |
Class library support |
green |
almost none |
Component manager |
N/A |
|