GlobalUsageGenerator

All Known Implementing Classes:

AbstractGlobalUsageGenerator, AbstractPrintedGlobalUsageGenerator, BashCompletionGenerator, CliGlobalUsageGenerator, CliGlobalUsageSummaryGenerator, ManGlobalUsageGenerator, ManMultiPageGlobalUsageGenerator, MarkdownGlobalUsageGenerator, MarkdownMultiPageGlobalUsageGenerator
```
public interface GlobalUsageGenerator<T>
```
Interface implemented by classes that can generate usage documentation for a command line interface

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`usage(GlobalMetadata<T> global)`	Generate the help and output it on standard out
`void`	`usage(GlobalMetadata<T> global, java.io.OutputStream output)`	Generate the help and output it to the stream

- Method Detail
  - usage
```
void usage(GlobalMetadata<T> global)
    throws java.io.IOException
```
    Generate the help and output it on standard out
    
    Parameters:
    
    global - Global Metadata
    
    Throws:
    
    java.io.IOException - Thrown if there is a problem generating usage output
  - usage
```
void usage(GlobalMetadata<T> global,
           java.io.OutputStream output)
    throws java.io.IOException
```
    Generate the help and output it to the stream
    
    Parameters:
    
    global - Global metadata
    
    output - Stream to output to
    
    Throws:
    
    java.io.IOException - Thrown if there is a problem generating usage output