Docs

java.lang.Object
- tilda.Docs

```
public class Docs
extends java.lang.Object
```
Generates HTML-based documentation and exports generated SQL for the Tilda resources specified in the input configuration file and available in the classpath.
The utility can take 1 or more parameters:
- A mandatory path to the folder where to put the documentation files from active Tilda schemas in the classpath.
- An optional path to a tilda.master.xxx.json file, or a list of schema names, to extract a subset of the documentation for specified schemas.
For example:
- Export docs and SQL for ALL the Tilda schemas found in the classpath
```
    tilda.Docs C:\projects\docs\
 
```
- Export docs and SQL for the Tilda schemas listed in the master configuration file and their dependencies, grouped as defined, and found in the classpath.
```
   tilda.Docs C:\projects\docs\ tilda.master.blah.json
 
```
- Export docs and SQL for the Tilda schemas Schema1 and Schema2 (and their dependencies), found in the classpath.
```
    tilda.Docs C:\projects\docs\ Schema1 Schema2
 
```
The master configuration file is a JSON-based file as defined by Docs.MasterConfig. The utility will export an HTML file TILDA___Docs.[schema_name].html and TILDA___[db_type].[schema_name].sql, and a master index file index.html. For example:
```
    index.html
    TILDA___Docs.SCHEMA1.html
    TILDA___PostgreSQL.SCHEMA1.sql
 
```
Author:

Laurent Hasson

See Also:

Docs.MasterConfig, main(String[])

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Docs.MasterConfig
GSon-based definition for the Master Index definitionfor the command line Docs utility.

Constructor Summary

Constructors
Constructor Description

Docs()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`main(java.lang.String[] Args)`	The main entry point for this command-line utility to generate documentation and SQL exports for Tilda schemas in the classpath.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Docs
```
public Docs()
```
- Method Detail
  - main
```
public static void main(java.lang.String[] Args)
```
    The main entry point for this command-line utility to generate documentation and SQL exports for Tilda schemas in the classpath.
    
    Parameters:
    
    Args - The parameters as defined for Docs.
    
    See Also:
    
    Docs, Docs.MasterConfig