Package wtf.choco.veinminer.documentation

Class Main

java.lang.Object

wtf.choco.veinminer.documentation.Main

public final class Main
extends Object

A program that will generate documentation in markdown format (and HTML tables) for VeinMiner's messaging protocol. The generated markdown is printed to the default output stream, but an argument may be supplied to specify an output file to which the data will be written instead.

Constructor Summary

Constructors

Constructor	Description
Main()

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	The entry point of the program.

Methods inherited from class java.lang.Object

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

Constructor Details

Main

public Main()

Method Details

main

public static void main(String[] args)
                 throws Exception

The entry point of the program.

Generates a Markdown-formatted string documenting VeinMiner's protocol. Documentation for each individual packet is determined by the Documentation annotation (see the annotation docs for more information).

Optional arguments:

• [0] = "legacy" - Documents the legacy protocol

Parameters:

args - arguments

Throws:

Exception - if an exception occurs