[bvalid-codewatch] SF.net SVN: bvalid: [42] trunk/src/doc
Status: Beta
Brought to you by:
cwilper
Menu
▾
▴
[bvalid-codewatch] SF.net SVN: bvalid: [42] trunk/src/doc
|
From: <cw...@us...> - 2006-05-15 15:11:32
|
Revision: 42 Author: cwilper Date: 2006-05-15 08:11:20 -0700 (Mon, 15 May 2006) ViewCVS: http://svn.sourceforge.net/bvalid/?rev=42&view=rev Log Message: ----------- doc updates Modified Paths: -------------- trunk/src/doc/index.html trunk/src/doc/license/index.html Added Paths: ----------- trunk/src/java/net/sf/bvalid/catalog/package.html trunk/src/java/net/sf/bvalid/locator/package.html trunk/src/java/net/sf/bvalid/package.html trunk/src/java/net/sf/bvalid/util/package.html trunk/src/java/net/sf/bvalid/xsd/package.html Modified: trunk/src/doc/index.html =================================================================== --- trunk/src/doc/index.html 2006-05-11 21:34:06 UTC (rev 41) +++ trunk/src/doc/index.html 2006-05-15 15:11:20 UTC (rev 42) @@ -19,7 +19,7 @@ <ol> <li><a href="#intro">What is BValid?</a></li> - <li><a href="#inst">How to Download</a></li> + <li><a href="#inst">Downloading and Installing</a></li> <li><a href="#api">API Documentation</a></li> <li><a href="#cmdline">Command-Line Utility</a></li> <li><a href="#issues">Known Issues / Bugs</a></li> @@ -47,7 +47,7 @@ <div class="sec2"> - <h2><a name="inst">2. How to Download</a></h2> + <h2><a name="inst">2. Downloading and Installing</a></h2> <p> The latest distribution (source and binary) can be downloaded from <a href="http://www.sf.net/projects/bvalid">http://www.sf.net/projects/bvalid</a> @@ -60,6 +60,10 @@ To begin using bvalid in your own projects, you'll need the required jars (included in the lib/ directory) in your CLASSPATH. </p> + <p> + Note: The binary distribution is compiled for Java 1.4. + Currently, BValid will compile and run with Java 1.4 and Java 1.5. + </p> </div> <div class="sec2"> @@ -207,7 +211,11 @@ versions will also support <a href="http://www.schematron.com/">Schematron</a> and <a href="http://www.relaxng.org/">Relax NG</a> validation. </li> - <li> <code>ValidationException</code> isn't clear about how multiple validation errors are reported.</li> + <li> <code>ValidationException</code> currently only reports multiple errors as a multi-line string. An alternate method (getErrorList?) would be nice.</li> + <li> Javadocs are incomplete (params, returns, throws, and some fields).</li> + <li> Some unit tests still need to be written. In particular, multithreaded + validation tests and whitebox tests for SchemaCatalog and SchemaLocator + implementations.</li> <li> Should the API include more direct support for schema whitelisting? Currently this is possible by writing your own SchemaLocator.</li> </ul> Modified: trunk/src/doc/license/index.html =================================================================== --- trunk/src/doc/license/index.html 2006-05-11 21:34:06 UTC (rev 41) +++ trunk/src/doc/license/index.html 2006-05-15 15:11:20 UTC (rev 42) @@ -106,6 +106,7 @@ </div> </li> +<!-- <li>Jing RELAX NG Validator <div class="copyright"> Copyright © 2001-2003 Thai Open Source Software Center Ltd. @@ -135,6 +136,7 @@ Licensed under the <a href="schematron-license.txt">Schematron License</a>. </div> </li> +--> </ol> <h2><a name="add">Optional Software</a></h2> Added: trunk/src/java/net/sf/bvalid/catalog/package.html =================================================================== --- trunk/src/java/net/sf/bvalid/catalog/package.html (rev 0) +++ trunk/src/java/net/sf/bvalid/catalog/package.html 2006-05-15 15:11:20 UTC (rev 42) @@ -0,0 +1,10 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +</head> +<body bgcolor="white"> + +<code>SchemaCatalog</code> interface and implementations. + +</body> +</html> Added: trunk/src/java/net/sf/bvalid/locator/package.html =================================================================== --- trunk/src/java/net/sf/bvalid/locator/package.html (rev 0) +++ trunk/src/java/net/sf/bvalid/locator/package.html 2006-05-15 15:11:20 UTC (rev 42) @@ -0,0 +1,10 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +</head> +<body bgcolor="white"> + +<code>SchemaLocator</code> interface and implementations. + +</body> +</html> Added: trunk/src/java/net/sf/bvalid/package.html =================================================================== --- trunk/src/java/net/sf/bvalid/package.html (rev 0) +++ trunk/src/java/net/sf/bvalid/package.html 2006-05-15 15:11:20 UTC (rev 42) @@ -0,0 +1,33 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +</head> +<body bgcolor="white"> + +Main package of the BValid API. + +<p> +To use this API, an application will typically: + +<ol> + <li> Get an appropriate <a href="Validator.html">Validator</a> from the + <a href="ValidatorFactory.html">ValidatorFactory</a>.</li> + <li> Call one of the <code>validate(...)</code> methods + on that object (multiple times, from multiple threads, + if needed)</li> + <li> Catch and handle + <a href="ValidationException.html">ValidationException</a>, + as appropriate.</li> +</ol> + +<h2>Related Documentation</h2> + +For additional documentation, please see: +<ul> + <li><a target="_blank" href="../../../../index.html">The BValid User Guide</a> +</ul> + +<!-- Put @see and @since tags down here. --> + +</body> +</html> Added: trunk/src/java/net/sf/bvalid/util/package.html =================================================================== --- trunk/src/java/net/sf/bvalid/util/package.html (rev 0) +++ trunk/src/java/net/sf/bvalid/util/package.html 2006-05-15 15:11:20 UTC (rev 42) @@ -0,0 +1,12 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +</head> +<body bgcolor="white"> + +Miscellaneous utility classes. + +<!-- Put @see and @since tags down here. --> + +</body> +</html> Added: trunk/src/java/net/sf/bvalid/xsd/package.html =================================================================== --- trunk/src/java/net/sf/bvalid/xsd/package.html (rev 0) +++ trunk/src/java/net/sf/bvalid/xsd/package.html 2006-05-15 15:11:20 UTC (rev 42) @@ -0,0 +1,13 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> +<html> +<head> +</head> +<body bgcolor="white"> + +Implementation of the <code>Validator</code> interface for XSD, +and related classes. + +<!-- Put @see and @since tags down here. --> + +</body> +</html> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
