javafxdoc:javafxdoc

Note:This goal should be used as a Maven report.

Full name:

net.sf.jfxdplugin:maven-javafxdoc-plugin:1.0:javafxdoc

Description:

Generates documentation for the JavaFX code in a NON aggregator project using the standard Javafxdoc Tool.

Based on the Maven Javadoc Plugin version 2.6.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 1.0.
  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

Required Parameters

Name Type Since Description
reportOutputDirectory File 1.0 Specifies the destination directory where javafxdoc saves the generated HTML files.

Optional Parameters

Name Type Since Description
additionalJOptions String[] 1.0 Passes the specified flag directly to the runtime system. Example: 
<additionalJOptions>
<additionalJOption>-Xss128m</additionalJOption>
</additionalJOptions>

additionalXslOptions String[] 1.0 Passes the specified xsl parameter to the xsl transformer. Example: 
<additionalXslOptions>
<additionalXslOption>extra-js=xtra.js</additionalXslOption>
</additionalXslOptions>

bootclasspath String 1.0 Specifies the paths where the boot classes reside. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.
breakiterator boolean 1.0 Uses the sentence break iterator to determine the end of the first sentence.
Default value is: false.
debug boolean 1.0 Set this to 'true' to debug the Javafxdoc plugin. With this, the execution script and 'files' files are provided.

Default value is: false.
description String 1.0 The description of the Javafxdoc report.
destDir String 1.0 The name of the destination directory (used by the site plugin).
Default value is: apidocs.
doclet String 1.0 Specifies the class file that starts the doclet used in generating the documentation.
docletPath String 1.0 Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on.
encoding String 1.0 Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the project.build.sourceEncoding property.
Default value is: ${project.build.sourceEncoding}.
excludePackageNames String 1.0 Unconditionally excludes the specified packages and their subpackages. Multiple packages can be separated by colons (:).
extdirs String 1.0 Specifies the directories where extension classes reside. Separate directories in dirlist with a colon (:) on Solaris and a semi-colon (;) on Windows.
extracss String 1.0 Specifies an additional CSS file for the HTML output.
extrajs String 1.0 Specifies an additional JavaScript file for the HTML output.
failOnError boolean 1.0 Specifies whether the build will continue even if there are errors.
Default value is: false.
inputFiles File[] 1.0 Specifies additional XML input files that contain package/class information to be transformed into the HTML output.
javafxdocExecutable String 1.0 Sets the absolute path of the Javafxdoc Tool executable to use. A mere directory specification is sufficient to have the plugin use "javafxdoc" or "javafxdoc.exe" respectively from this directory.
locale String 1.0 Specifies the locale that javafxdoc uses when generating documentation.
mastercss String 1.0 Specifies the master CSS file for the HTML output.
name String 1.0 The name of the Javafxdoc report.
nohtml boolean 1.0 Prevents generating the HTML files for the documentation.
Default value is: false.
outputDirectory File 1.0 Specifies the destination directory where javafxdoc saves the generated HTML files.
Default value is: ${project.build.directory}/apidocs.
outputFile File 1.0 Specifies the XML output file.
profile String 1.0 Specifies the JavaFX platform. Valid values are "desktop" (default), "mobile", or "tv" (as of JavaFX 1.3).
Default value is: desktop.
quiet boolean 1.0 Shuts off status messages. Maybe.
Default value is: false.
show String 1.0 Specifies the access level for classes and members to show in the JavaFXDocs. Possible values are
  • public (Show only public classes and members)
  • protected (Show protected/public classes and members (default))
  • package (Show package/protected/public classes and members)
  • private (Show all classes and members)


Default value is: protected.
source String 1.0 Provides source compatability with the specified release.
sourcePath String 1.0 Specifies the source paths where the subpackages are located. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.
subpackages String 1.0 Generates documentation from source files in the specified packages and recursively in their subpackages.
verbose boolean 1.0 Provides more detailed messages while Javafxdoc is running.
Default value is: false.
xsltfile File 1.0 Specifies the XSL file to use for transforming the documentation.

Parameter Details

additionalJOptions:

Passes the specified flag directly to the runtime system. Example: 
<additionalJOptions>
<additionalJOption>-Xss128m</additionalJOption>
</additionalJOptions>
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

additionalXslOptions:

Passes the specified xsl parameter to the xsl transformer. Example: 
<additionalXslOptions>
<additionalXslOption>extra-js=xtra.js</additionalXslOption>
</additionalXslOptions>
  • Type: java.lang.String[]
  • Since: 1.0
  • Required: No

bootclasspath:

Specifies the paths where the boot classes reside. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${bootclasspath}

breakiterator:

Uses the sentence break iterator to determine the end of the first sentence.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${breakiterator}
  • Default: false

debug:

Set this to 'true' to debug the Javafxdoc plugin. With this, the execution script and 'files' files are provided.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${debug}
  • Default: false

description:

The description of the Javafxdoc report.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${description}

destDir:

The name of the destination directory (used by the site plugin).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${destDir}
  • Default: apidocs

doclet:

Specifies the class file that starts the doclet used in generating the documentation.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${doclet}

docletPath:

Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${docletPath}

encoding:

Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the project.build.sourceEncoding property.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

excludePackageNames:

Unconditionally excludes the specified packages and their subpackages. Multiple packages can be separated by colons (:).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${excludePackageNames}

extdirs:

Specifies the directories where extension classes reside. Separate directories in dirlist with a colon (:) on Solaris and a semi-colon (;) on Windows.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${extdirs}

extracss:

Specifies an additional CSS file for the HTML output.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${extracss}

extrajs:

Specifies an additional JavaScript file for the HTML output.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${extrajs}

failOnError:

Specifies whether the build will continue even if there are errors.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${failOnError}
  • Default: false

inputFiles:

Specifies additional XML input files that contain package/class information to be transformed into the HTML output.
  • Type: java.io.File[]
  • Since: 1.0
  • Required: No

javafxdocExecutable:

Sets the absolute path of the Javafxdoc Tool executable to use. A mere directory specification is sufficient to have the plugin use "javafxdoc" or "javafxdoc.exe" respectively from this directory.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${javafxdocExecutable}

locale:

Specifies the locale that javafxdoc uses when generating documentation.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${locale}

mastercss:

Specifies the master CSS file for the HTML output.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${mastercss}

name:

The name of the Javafxdoc report.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${name}

nohtml:

Prevents generating the HTML files for the documentation.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${nohtml}
  • Default: false

outputDirectory:

Specifies the destination directory where javafxdoc saves the generated HTML files.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${outputDirectory}
  • Default: ${project.build.directory}/apidocs

outputFile:

Specifies the XML output file.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${outputFile}

profile:

Specifies the JavaFX platform. Valid values are "desktop" (default), "mobile", or "tv" (as of JavaFX 1.3).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${profile}
  • Default: desktop

quiet:

Shuts off status messages. Maybe.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${quiet}
  • Default: false

reportOutputDirectory:

Specifies the destination directory where javafxdoc saves the generated HTML files.
  • Type: java.io.File
  • Since: 1.0
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}/apidocs

show:

Specifies the access level for classes and members to show in the JavaFXDocs. Possible values are
  • public (Show only public classes and members)
  • protected (Show protected/public classes and members (default))
  • package (Show package/protected/public classes and members)
  • private (Show all classes and members)

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${show}
  • Default: protected

source:

Provides source compatability with the specified release.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${source}

sourcePath:

Specifies the source paths where the subpackages are located. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${sourcePath}

subpackages:

Generates documentation from source files in the specified packages and recursively in their subpackages.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${subpackages}

verbose:

Provides more detailed messages while Javafxdoc is running.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${verbose}
  • Default: false

xsltfile:

Specifies the XSL file to use for transforming the documentation.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Expression: ${xsltfile}