screenshot:javadoc

Full name:

se.bluebrim.maven.plugin:screenshot-maven-plugin:1.0.3-SNAPSHOT:javadoc

Description:

Generates screenshots to be included in the Javadoc for the panel class that is the source of the screenshot.

Attributes:

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

Optional Parameters

Name Type Since Description
<javaDocImageScale> float - Javadoc screenshot scale factor. Used to reduce the size of the screenshots to get a more pleasant experience when viewing Javadoc in your IDE. 0.6 is a recommended value.
Must be > 0.0 and =< 1.0
Default value is: 1.
<locales> List - Specify the locale to be used when generating the screenshots. In a previous version it was possible to specify several locales and get side-by-side screenshots for each locale. This feature is disabled for now but you can still use this parameter to specify one single locale in cases where the default locale is not desirable.
<srcFileEncoding> String - The encoding of the Java source files to be used when the parameter updateSrcFiles = true If not specified the default encoding of the platform will be used.
<updateSrcFiles> boolean - If true, the Java source files of the screenshot target classes will be checked for missing <img src="doc-files/xxxxxxx.png"> tags and missing tags will be added. The implementation of this feature are experimental and somewhat naive so use this with care. The parsing of source files are done with QDoc and parsing of Javadoc comments are done with ParserDelegator. Adding of missing comments and image tags are done by looping through the lines and trying to find the insertion point by simple string comparision. This is the naive part that should be improved.
Default value is: false.

Parameter Details

<javaDocImageScale>

Javadoc screenshot scale factor. Used to reduce the size of the screenshots to get a more pleasant experience when viewing Javadoc in your IDE. 0.6 is a recommended value.
Must be > 0.0 and =< 1.0
  • Type: float
  • Required: No
  • Default: 1

<locales>

Specify the locale to be used when generating the screenshots. In a previous version it was possible to specify several locales and get side-by-side screenshots for each locale. This feature is disabled for now but you can still use this parameter to specify one single locale in cases where the default locale is not desirable.
  • Type: java.util.List
  • Required: No

<srcFileEncoding>

The encoding of the Java source files to be used when the parameter updateSrcFiles = true If not specified the default encoding of the platform will be used.
  • Type: java.lang.String
  • Required: No

<updateSrcFiles>

If true, the Java source files of the screenshot target classes will be checked for missing <img src="doc-files/xxxxxxx.png"> tags and missing tags will be added. The implementation of this feature are experimental and somewhat naive so use this with care. The parsing of source files are done with QDoc and parsing of Javadoc comments are done with ParserDelegator. Adding of missing comments and image tags are done by looping through the lines and trying to find the insertion point by simple string comparision. This is the naive part that should be improved.
  • Type: boolean
  • Required: No
  • Default: false