SupportDocumentationGenerator (Jervis 2.0 API)

net.gleske.jervis.beta.SupportDocumentationGenerator

This is a utility class for Jervis admins to generate documentation on the fly for their specific environment. An admin will bring their own platforms.json, a JSON file for language lifecycles for each operating system they support, and a JSON file for language toolchains for each operating system they support. Without this generator, managing documentation for a custom solution is very hard. This documentation generator was developed to make managing docs a little easier for Jervis platforms and environments.
Sample usage

To run this example, clone Jervis and execute ./gradlew console to bring up a Groovy Console with the classpath set up.
```
import net.gleske.jervis.tools.SupportDocumentationGenerator as Doc

Doc docs = new Doc()

println docs.supportByOS
```

Properties Summary

Properties
Type	Name and description
`Map`	`jsonFiles` Contains the parsed content of all Jervis JSON files such as platforms, lifecycles, and toolchains for every OS.
`String`	`serviceName`
`Map`	`supportByOS`
`Map`	`templates` Groovy templates for generating documenation.

Constructor Summary

Constructors
Constructor and description
`SupportDocumentationGenerator ()`
`SupportDocumentationGenerator (Map args)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`getLifecycleDocumentation(String os = '')` Get the full supported language documentation for a given operating system.
	`String`	`getLifecycleDocumentation(String os, String language)` Return markdown documentation for a given OS supporting a language.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - Map jsonFiles
    
    Contains the parsed content of all Jervis JSON files such as platforms, lifecycles, and toolchains for every OS. Each key is the name of the JSON file but without .json extension, without -stable.json, or without -unstable.json depending on default stability.
  - String serviceName
  - Map supportByOS
  - Map templates
    
    Groovy templates for generating documenation.
    The following templates are supported.
    - lifecycle-introduction contains the contents of lifecycle-introduction.tmpl.md. This is the documentation at the top of each language for its lifecycles documentation. For each build tool supported for default lifecycles refer to the lifecycle template.
    - lifecycle contains the contents of lifecycle.tmpl.md. This template is for documenting file detection and fallback behavior for different build tools in the lifecycle phase of a supported language.
- Constructor Detail
  - SupportDocumentationGenerator()
  - SupportDocumentationGenerator(Map args)
- Method Detail
  - String getLifecycleDocumentation(String os = '')
    
    Get the full supported language documentation for a given operating system.
    Parameters:
    os - An operating system supported in platforms, lifecycles, and toolchains JSON files.
    Returns:
    A rendered markdown document.
  - String getLifecycleDocumentation(String os, String language)
    
    Return markdown documentation for a given OS supporting a language.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Jervis API documentation.

[Groovy] Class SupportDocumentationGenerator

Sample usage

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Map jsonFiles

String serviceName

Map supportByOS

Map templates

Constructor Detail

SupportDocumentationGenerator()

SupportDocumentationGenerator(Map args)

Method Detail

String getLifecycleDocumentation(String os = '')

String getLifecycleDocumentation(String os, String language)