<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<head>
    <name>About AutoDoc</name>
    <doc-version>$Date: 2003/05/04 06:40:13 $</doc-version>
    <author>Matt Albrecht</author>
</head>
<body>
<P>
The AutoDoc collection allows tests to be self-documenting.  The framework
is a pluggable system to allow any type of implementation of the core
functionality.
</P>
<P>
The current API set allows for:
<UL>
    <definition term="logging">
    Access to logging APIs similar to the
    Java logging interface or the Jakarta Log4j project.
    </definition>
    <definition term="pmti">
    (problem management tracking interface) Allows for tests to mark
    themselves as testing a specific bug.  The generated files (or plugins) can
    then be used to connect to the bug tracker and record if the test fails
    or passes.  This allows for better traceability of what bugs were fixed,
    if the fix works, and what remains to be tested.
    </definition>
    <definition term="tp">
    (test plans) Allows for tests to generate a test plan based on the code
    that executes.
    </definition>
</UL>
</P>
</body>
</document>

