Class Manuals

java.lang.Object

com.github.rvesse.airline.examples.cli.commands.Manuals

All Implemented Interfaces:

ExampleRunnable

@Command(name="generate-manuals",
         description="Generates manual pages for this CLI that can be rendered with the man tool")
public class Manuals
extends Object
implements ExampleRunnable

Field Summary

Fields

Modifier and Type	Field	Description
private GlobalMetadata<ExampleRunnable>	global
private boolean	includeHidden

Constructor Summary

Constructors

Constructor	Description
Manuals()

Method Summary

Modifier and Type	Method	Description
int	run()	Runs the command and returns an exit code that the application should return

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

global

@AirlineModule
private GlobalMetadata<ExampleRunnable> global

includeHidden

@Option(name="--include-hidden",
        description="When set hidden commands and options are shown in help",
        hidden=true)
private boolean includeHidden

Constructor Details

Manuals

public Manuals()

Method Details

run

public int run()

Description copied from interface: ExampleRunnable

Runs the command and returns an exit code that the application should return

Specified by:

run in interface ExampleRunnable

Returns:

Exit code