/*
|
* The contents of this file are subject to the terms of the Common Development and
|
* Distribution License (the License). You may not use this file except in compliance with the
|
* License.
|
*
|
* You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
|
* specific language governing permission and limitations under the License.
|
*
|
* When distributing Covered Software, include this CDDL Header Notice in each file and include
|
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
|
* Header, with the fields enclosed by brackets [] replaced by your own identifying
|
* information: "Portions Copyright [year] [name of copyright owner]".
|
*
|
* Copyright 2015-2016 ForgeRock AS.
|
*/
|
package com.forgerock.opendj.cli;
|
|
import org.forgerock.i18n.LocalizableMessage;
|
|
/**
|
* Documentation that supplements generated descriptions.
|
*/
|
public interface DocDescriptionSupplement {
|
|
/**
|
* Retrieves a supplement to the description intended for use in generated reference documentation.
|
*
|
* @return The supplement to the description for use in generated reference documentation,
|
* or LocalizableMessage.EMPTY if there is no supplement.
|
*/
|
LocalizableMessage getDocDescriptionSupplement();
|
}
|
