/*
* Copyright (c) 2011-2017 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
*/
package io.vertx.core.cli.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
Annotates a CLI
with summary. The summary is the main short explanation of the command. Long description should be written in the Description
. Author: Clement Escoffier
/**
* Annotates a {@link io.vertx.core.cli.CLI} with summary. The summary is the main short explanation of the command. Long
* description should be written in the {@link Description}.
*
* @author Clement Escoffier <clement@apache.org>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Summary {
The summary. This should be a single sentence describing what the command does.
/**
* The summary. This should be a <strong>single</strong> sentence describing what the command does.
*/
String value();
}