robotframework:testdoc

Full name:

org.robotframework:robotframework-maven-plugin:1.4.7:testdoc

Description:

Create documentation of test suites using the Robot Framework testdoc tool. Uses the testdoc bundled in Robot Framework jar distribution. For more help see testdoc documentation.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Required Parameters

Name Type Since Description
testdoc TestDocConfiguration - Test case documentation configuration. Required settings:
  • outputFile The name for the output file.
  • dataSourceFile Name or path of the documented test case(s).
Paths are considered relative to the location of pom.xml and must point to a valid test case file. For example src/main/test/ExampleTest.txt Optional settings:
  • outputDirectory Specifies the directory where documentation files are written. Considered to be relative to the ${basedir} of the project. Default ${project.build.directory}/robotframework/testdoc
  • title Set the title of the generated documentation. Underscores in the title are converted to spaces. The default title is the name of the top level suite.
  • name Override the name of the top level test suite.
  • doc Override the documentation of the top level test suite.
Example:
<testdoc>
     <outputFile>MyTests.html</outputFile>
     <dataSourceFile>src/test/resources/MyTests.txt</dataSourceFile>
</testdoc>

Parameter Details

testdoc:

Test case documentation configuration. Required settings:
  • outputFile The name for the output file.
  • dataSourceFile Name or path of the documented test case(s).
Paths are considered relative to the location of pom.xml and must point to a valid test case file. For example src/main/test/ExampleTest.txt Optional settings:
  • outputDirectory Specifies the directory where documentation files are written. Considered to be relative to the ${basedir} of the project. Default ${project.build.directory}/robotframework/testdoc
  • title Set the title of the generated documentation. Underscores in the title are converted to spaces. The default title is the name of the top level suite.
  • name Override the name of the top level test suite.
  • doc Override the documentation of the top level test suite.
Example:
<testdoc>
     <outputFile>MyTests.html</outputFile>
     <dataSourceFile>src/test/resources/MyTests.txt</dataSourceFile>
</testdoc>
  • Type: org.robotframework.mavenplugin.TestDocConfiguration
  • Required: Yes