Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Run each of the unit tests in the test classes as indicated in table below so that passing unit tests get snippets generated in snippets folder ( 'build/doc/generated-snippets/' by default ). The table below shows documented services and corresponding test classes containing updated unit tests.

  2. Create an api-docs.adoc file using this https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ in sourceDir ( 'build/doc/asciidoc/' by default ) which references your recently generated snippets.

  3. Run ‘gradle asciidoctor' to get the api-docs.html file generated in the outputDir folder ( 'build/doc/html5/' by default )

...