in tooling/karaf-maven-plugin/src/main/java/org/apache/karaf/tooling/commands/AsciiDoctorCommandHelpPrinter.java [37:142]
public void printHelp(Action action, PrintStream out, boolean includeHelpOption) {
Command command = action.getClass().getAnnotation(Command.class);
Set<Option> options = new HashSet<>();
List<Argument> arguments = new ArrayList<>();
Map<Argument, Field> argFields = new HashMap<>();
Map<Option, Field> optFields = new HashMap<>();
for (Class<?> type = action.getClass(); type != null; type = type.getSuperclass()) {
for (Field field : type.getDeclaredFields()) {
Option option = field.getAnnotation(Option.class);
if (option != null) {
options.add(option);
}
Argument argument = field.getAnnotation(Argument.class);
if (argument != null) {
argument = replaceDefaultArgument(field, argument);
argFields.put(argument, field);
int index = argument.index();
while (arguments.size() <= index) {
arguments.add(null);
}
if (arguments.get(index) != null) {
throw new IllegalArgumentException("Duplicate argument index: " + index + " on Action " + action.getClass().getName());
}
arguments.set(index, argument);
}
}
}
if (includeHelpOption)
options.add(HelpOption.HELP);
out.println("= " + command.scope() + ":" + command.name());
out.println();
out.println("== Description");
out.println();
out.println(command.description());
out.println();
StringBuilder syntax = new StringBuilder();
syntax.append(String.format("%s:%s", command.scope(), command.name()));
if (options.size() > 0) {
syntax.append(" [options]");
}
if (arguments.size() > 0) {
syntax.append(' ');
for (Argument argument : arguments) {
syntax.append(String.format(argument.required() ? "%s " : "[%s] ", argument.name()));
}
}
out.println("== Syntax");
out.println();
out.println(syntax.toString());
out.println();
if (arguments.size() > 0) {
out.println("== Arguments");
out.println();
out.println("|===");
out.println("|Name |Description");
for (Argument argument : arguments) {
String description = argument.description();
if (!argument.required()) {
Object o = getDefaultValue(action, argFields.get(argument));
String defaultValue = getDefaultValueString(o);
if (defaultValue != null) {
description += " (defaults to " + o.toString() + ")";
}
}
out.println();
out.println("| " + argument.name());
out.println("| " + description);
}
out.println("|===");
out.println();
}
if (options.size() > 0) {
out.println("== Options");
out.println();
out.println("|===");
out.println("|Name |Description");
for (Option option : options) {
StringBuilder opt = new StringBuilder(option.name());
String desc = option.description();
for (String alias : option.aliases()) {
opt.append(", ").append(alias);
}
Object o = getDefaultValue(action, optFields.get(option));
String defaultValue = getDefaultValueString(o);
if (defaultValue != null) {
desc += " (defaults to " + defaultValue + ")";
}
out.println();
out.println("|" + opt);
out.println("|" + desc);
}
out.println("|===");
out.println();
}
if (command.detailedDescription().length() > 0) {
out.println("== Details");
out.println();
out.println(command.detailedDescription());
}
out.println();
}