https://github.com/perfectsense/gyro-doclet

Java Doclet to generate reference documentation for Gyro cloud automation tool.
https://github.com/perfectsense/gyro-doclet

devops infrastructure-as-code java

Last synced: 6 days ago
JSON representation

Java Doclet to generate reference documentation for Gyro cloud automation tool.

• Host: GitHub
• URL: https://github.com/perfectsense/gyro-doclet
• Owner: perfectsense
• License: apache-2.0
• Created: 2019-03-05T12:59:08.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-08T19:11:12.000Z (11 months ago)
• Last Synced: 2024-11-29T12:51:16.536Z (2 months ago)
• Topics: devops, infrastructure-as-code, java
• Language: Java
• Homepage: https://github.com/perfectsense/gyro
• Size: 112 KB
• Stars: 0
• Watchers: 43
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Gyro Provider Reference Documentation Doclet

============================================

This doclet extracts reference documentation for provider implements from

JavaDocs.

Please follow these rules:

- Class level javadocs should have a single sentence explaining what the

  resource creates.  Include a simple example that includes all required attributes

  and possibly optional attributes if they're extremely common.  Optionally 

  include a link to AWS documention relating the resource. 

- Use the following format for examples:

```

.. code-block:: gyro

    aws::resource name

        attribute1: value1

        attribute2: value2

    end

```

- Field level javadocs should be documented on the getter for the particular

  attribute, not on the field. This allows use to read the annotations and use them

  in the documentation. For now field level documentation should be limited to a single 

  concise sentence. Do not just copy the field level documentation from the provider

  SDK. Optionally include a link to AWS documention relating the resource.

- Fields should be ordered as such: required fields first, then optional fields, finally

  read-only fields.

## License

[Apache License 2.0](https://github.com/perfectsense/gyro-doclet/blob/master/LICENSE)