Menu
▾
▴
[Cdk-commits] CVS: cdk/doc/website/source qualitycontrol.xml,NONE,1.1 layout.xml,1.47,1.48
|
From: Egon W. <eg...@us...> - 2004-07-07 08:13:50
|
Update of /cvsroot/cdk/cdk/doc/website/source In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv10228 Modified Files: layout.xml Added Files: qualitycontrol.xml Log Message: Added a bit more info to the website and did a bit of restructuring --- NEW FILE: qualitycontrol.xml --- <?xml version="1.0"?> <!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.0b1//EN" "dtd/website.dtd"> <webpage id="qualitycontrol"> <config param="last-change-by" value="$Author: egonw $"/> <config param="rcsdate" value="$Date: 2004/07/07 08:13:41 $"/> <head> <title>Quality Control</title> <titleabbrev>Quality Control</titleabbrev> <summary>Description on how the CDK project tries to keep top quality algorithm implementations and source code.</summary> </head> <para> This page describes how the CDK Project tries to maintain the quality of both the source code as well as the implemented algorithms. </para> <para> The results of tests described below are found in the left menu. </para> <section> <title>Algorithm Quality</title> <para> The quality of the algorithms is measured using JUnit testing. These tests check wether the classes in the library perform as they are expected. This means both that the data classes act as expected, but also that algorithms function as expected. It's important to repeat these tests over and over again to be able to maintain the source code (in terms of API changes, relayout, faster algorithm implementation, etc). </para> <para> Currently, the results of the JUnit tests are not online, but with the Ant <filename>build.xml</filename> script these can be reproduced with the <command>test-all</command> target. </para> </section> <section> <title>Source code Quality</title> <para> At this moment, the quality of the source code is measured using PMD and the use of JavaDoc. The first checks for many common and less common coding mistakes, like empty if-blocks, empty try-blocks and unused variables. The JavaDoc test results show how well the classes are documented, and this is, ofcourse, of major importance to program developers who would like to use the CDK library. </para> </section> </webpage> Index: layout.xml =================================================================== RCS file: /cvsroot/cdk/cdk/doc/website/source/layout.xml,v retrieving revision 1.47 retrieving revision 1.48 diff -u -r1.47 -r1.48 --- layout.xml 30 Jun 2004 12:50:29 -0000 1.47 +++ layout.xml 7 Jul 2004 08:13:41 -0000 1.48 @@ -69,9 +69,11 @@ <tocentry page="guide-packages.xml" filename="guide-packages.html"/> <tocentry page="guide-website-development.xml" filename="guide-website-development.html"/> </tocentry> + <tocentry page="qualitycontrol.xml" filename="qualitycontrol.html"> + <tocentry page="pmd.xml" filename="pmd.html"/> <tocentry page="javadoc-stats.xml" filename="javadoc-stats.html"/> <tocentry page="javancss-stats.xml" filename="javancss-stats.html"/> - <tocentry page="pmd.xml" filename="pmd.html"/> + </tocentry> <tocentry page="modules.xml" filename="modules.html"> <tocentry page="module-core.xml" filename="module-core.html"/> <tocentry page="module-standard.xml" filename="module-standard.html"/> @@ -79,6 +81,9 @@ <tocentry page="module-render.xml" filename="module-render.html"/> <tocentry page="module-extra.xml" filename="module-extra.html"/> </tocentry> + <tocentry id="SFBugs" href="http://sourceforge.net/tracker/?group_id=20024&atid=120024"> + <title>Bugs</title> + </tocentry> </tocentry> <tocentry page="changelog.xml" filename="changelog.html"/> <tocentry page="contact.xml" filename="contact.html"/> |