License Annotation

@License

The @License annotation may be applied to classes and provides a license statement that will be included in Help as an additional section.

To use it simply add it like so:

@License(paragraphs =
         {
           "This command is licensed under the Apache License 2.0"
         },
         url = "http://apache.org/license/2.0")
public class MyClass { }

The paragraphs field provides an array of strings where each string is a paragraph that is used to describe the license. The url field may be used to provide a URL where the user can find further license information.

Improving this Documentation

This documentation is itself open source and lives in GitHub under the docs/ directory.

I am not a professional technical writer and as the developer of this software I can often make assumptions of knowledge that you as a user reading this may not have. Improvements to the documentation are always welcome, if you have suggestions for the documentation please submit pull requests to the main branch.