Javadoc

Javadoc is a tool for generating API documentation in HTML format from Java source code.

YAML Configuration

javadoc:

  • input:

    • Defaults to the repository root.
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.75 CPU with 2880 MiB RAM.

      Docstand configures the maximum heap size (-Xmx) of the Java virtual machine (JVM) according to this value. Docstand reserves 240 MiB RAM for system, and makes the rest of RAM available to JVM for heap allocation. For example, -Xmx2640m is specified by default (for 0.75 CPU), -Xmx5520m is specified for 1.5 CPU.

  • options:

    Below is the supported option:

    -encoding <name>                 Source file encoding name. Defaults to utf-8.
    -charset <charset>               Charset for cross-platform viewing of generated documentation. Defaults to utf-8.
    -stylesheetfile <path>           File to change style of the generated documentation. Defaults to utf-8.
    -docencoding <name>              Specify the character encoding for the output
    

Resolving Dependencies

If AndroidManifest.xml is present in the repository, Docstand checks the target version of Android SDK in AndroidManifest.xml and installs it.

Examples

  • With input option

    docstand:
      javadoc:
        input:
          - src/
          - demos/
    
  • With custom machine:

    docstand:
      javadoc:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With customized javadoc

    docstand:
      javadoc:
        options:
          -stylesheetfile: assets/css/javadoc-custom.css
          -charset: ISO-8859-1
    

results matching ""

    No results matching ""