Index (jdoctest 2.0 documentation)

C

collectAllTests(File, List<File>) - Static method in class net.cscott.jdoctest.JsJUnitTestBridge
collectTestsFor(File, Class<?>, List<File>) - Static method in class net.cscott.jdoctest.JsJUnitTestBridge

discover(EngineDiscoveryRequest, UniqueId) - Method in class net.cscott.jdoctest.JDoctestEngine
doctests(String) - Static method in class net.cscott.jdoctest.RerunJDoctests: Returns a test for each javascript test found beneath the given directory.
Doctests - Annotation Interface in net.cscott.jdoctest: Indicates that the javadoc of the annotated class contains doctests which should be run as JUnit tests.

ENGINE_ID - Static variable in class net.cscott.jdoctest.JDoctestEngine: The ID of this test engine.
execute(ExecutionRequest) - Method in class net.cscott.jdoctest.JDoctestEngine

getAllowedLocations() - Method in class net.cscott.jdoctest.JDoctest: Will return all locations, since @doc.test can be used in overview, module, package, type, constructor, method, and field documentation.
getGroupId() - Method in class net.cscott.jdoctest.JDoctestEngine
getId() - Method in class net.cscott.jdoctest.JDoctestEngine
getName() - Method in class net.cscott.jdoctest.JDoctest: Return the name of this custom tag.
getVersion() - Method in class net.cscott.jdoctest.JDoctestEngine

init(DocletEnvironment, Doclet) - Method in class net.cscott.jdoctest.JDoctest: Initialize this Taglet.
isInlineTag() - Method in class net.cscott.jdoctest.JDoctest: Will return false since @doc.test is not an inline tag.

JavadocJUnitTestBridge - Class in net.cscott.jdoctest: JUnit test bridge to generate and run the doc tests from a specific Java source file.
JavadocJUnitTestBridge(Class<?>, File) - Constructor for class net.cscott.jdoctest.JavadocJUnitTestBridge
JDoctest - Class in net.cscott.jdoctest: JDoctest implementing doctests via a @doc.test taglet.
JDoctest() - Constructor for class net.cscott.jdoctest.JDoctest
JDoctestEngine - Class in net.cscott.jdoctest: JUnit Platform test engine which runs the doctests of classes annotated with Doctests.
JDoctestEngine() - Constructor for class net.cscott.jdoctest.JDoctestEngine
JsJUnitTestBridge - Class in net.cscott.jdoctest: JUnit test bridge to re-run the doc tests in the specific javascript file.
JsJUnitTestBridge(File) - Constructor for class net.cscott.jdoctest.JsJUnitTestBridge

listTests(String) - Static method in class net.cscott.jdoctest.RerunJDoctests: List all the javascript tests found beneath the given directory.

main(String[]) - Static method in class net.cscott.jdoctest.JavadocJUnitTestBridge
main(String[]) - Static method in class net.cscott.jdoctest.JsJUnitTestBridge
main(String[]) - Static method in class net.cscott.jdoctest.Version: Prints the package version if invoked.

PACKAGE_BUGREPORT - Static variable in class net.cscott.jdoctest.Version: The address to which bug reports should be sent.
PACKAGE_NAME - Static variable in class net.cscott.jdoctest.Version: The name of the package.
PACKAGE_STRING - Static variable in class net.cscott.jdoctest.Version: The package name and version as one string.
PACKAGE_VERSION - Static variable in class net.cscott.jdoctest.Version: The version of the package.

rerunDoctests() - Method in class net.cscott.jdoctest.RerunJDoctests
RerunJDoctests - Class in net.cscott.jdoctest: This is a JUnit test which re-runs all of the doctests emitted by JDoctest.
RerunJDoctests() - Constructor for class net.cscott.jdoctest.RerunJDoctests
runDoctest() - Method in class net.cscott.jdoctest.JavadocJUnitTestBridge
runDoctest() - Method in class net.cscott.jdoctest.JsJUnitTestBridge
runDoctest(File) - Static method in class net.cscott.jdoctest.JsJUnitTestBridge
runDoctest(Class<?>, File) - Static method in class net.cscott.jdoctest.JavadocJUnitTestBridge
runDoctest(String) - Static method in class net.cscott.jdoctest.JsJUnitTestBridge
runDoctest(String, String) - Static method in class net.cscott.jdoctest.JsJUnitTestBridge

sourceFile - Variable in class net.cscott.jdoctest.JavadocJUnitTestBridge
SRC_ROOT_PARAMETER - Static variable in class net.cscott.jdoctest.JDoctestEngine: JUnit configuration parameter giving the default source directory for Doctests classes which don't specify one.
srcRoot() - Element in annotation interface net.cscott.jdoctest.Doctests: The directory containing the source file of the annotated class.

testDir() - Method in class net.cscott.jdoctest.RerunJDoctests: Override this in your subclass to change the test directory.
testFile - Variable in class net.cscott.jdoctest.JsJUnitTestBridge
toString(List<? extends DocTree>, Element) - Method in class net.cscott.jdoctest.JDoctest: Given a list of DocTrees representing this custom tag, return its string representation.

Version - Class in net.cscott.jdoctest: The Version object contains fields naming the current version of the jdoctest application (2.0).
Version() - Constructor for class net.cscott.jdoctest.Version