Full name:
org.robotframework:robotframework-maven-plugin:2.1.0:libdoc
Description:
libdoc
tool. Uses the
libdoc
bundled in Robot Framework jar distribution.
For more help see libdoc
documentation.Attributes:
test
.Name | Type | Since | Description |
---|---|---|---|
<libdoc> |
LibDocConfiguration |
- |
Library documentation configuration. Required settings:
<libdoc> <outputFile>MyLib.html</outputFile> <libraryOrResourceFile>com.mylib.MyLib</libraryOrResourceFile> </libdoc> <libdoc> <outputFile>*.html</outputFile> <libraryOrResourceFile>src/java/**/*Lib.java</libraryOrResourceFile> </libdoc> <libdoc> <outputFile>*.html</outputFile> <libraryOrResourceFile>com.**.*Lib</libraryOrResourceFile> </libdoc> |
Name | Type | Since | Description |
---|---|---|---|
<externalRunner> |
ExternalRunnerConfiguration |
- |
Test are executed in a new process if this configuration is used. The classpath for the new process will include by default all the test scope dependencies from the pom.
|
Test are executed in a new process if this configuration is used.
The classpath for the new process will include by default all the test scope dependencies from the pom.
<externalRunner>
<environmentVariables>
<foo>bar</foo>
<CLASSPATH>this-should-be-seen-by-external-process.jar</CLASSPATH>
</environmentVariables>
<jvmArgs>
<jvmArg>-XX:PermSize=128m</jvmArg>
<jvmArg>-XX:MaxPermSize=256m</jvmArg>
<jvmArg>-Xmx512m</jvmArg>
</jvmArgs>
<excludeDependencies>true</excludeDependencies>
<runnerClass>org.robotframework.RobotFramework</runnerClass>
<runWithPython>false</runWithPython>
</externalRunner>
org.robotframework.mavenplugin.ExternalRunnerConfiguration
No
outputFile
The name for the output file.
Documentation output format is deduced from the file extension. We
also support patterns like *.html
, which indicates to
derive the output name from the original name.libraryOrResourceFile
Name or path of the
documented library or resource file. Supports ant-like pattern
format to match multiple inputs, such as
src/java/**/*.java
Name must be in the same format as
when used in Robot Framework test data, for example
BuiltIn
or com.acme.FooLibrary
. When name
is used, the library is imported the same as when running the
tests. Use extraPathDirectories to set PYTHONPATH/CLASSPATH
accordingly. Paths are considered relative to the location of
pom.xml
and must point to a valid Python/Java source
file or a resource file. For example
src/main/python/test/ExampleLib.py
Note that you
should preferably import java classes by classname, not path.
Dynamic libraries will not be compiled correctly with path.outputDirectory
Specifies the directory where
documentation files are written. Considered relative to the
${basedir} of the project, but also supports absolute paths.
Defaults to ${project.build.directory}/robotframework/libdocname
Sets the name of the documented library or
resource.version
Sets the version of the documented library
or resource.extraPathDirectories
A directory to be added to
the PYTHONPATH/CLASSPATH when creating documentation. e.g.
src/main/java/com/test/<libdoc> <outputFile>MyLib.html</outputFile> <libraryOrResourceFile>com.mylib.MyLib</libraryOrResourceFile> </libdoc>
<libdoc> <outputFile>*.html</outputFile> <libraryOrResourceFile>src/java/**/*Lib.java</libraryOrResourceFile> </libdoc>
<libdoc> <outputFile>*.html</outputFile> <libraryOrResourceFile>com.**.*Lib</libraryOrResourceFile> </libdoc>
org.robotframework.mavenplugin.LibDocConfiguration
Yes