@Alias
The @Alias
annotation is used as an argument to the aliases
field of the @Parser
annotation. It is used to define a command alias in the same manner as users can provide aliases via the User Defined Aliases feature.
The @Alias
annotation has two required fields, name
specifies the name of the alias i.e. the name typed to invoke the alias while arguments
takes an array of the arguments that are used to expand the alias e.g.
@Parser(aliases = {
@Alias(name = "rem",
arguments = { "remove" })
})
Here we define a single alias rem
which invokes the remove
command.
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.