com.ly.doc.constants.TemplateVariable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smart-doc Show documentation

Smart-doc is a tool that supports both JAVA RESTFUL API and Apache Dubbo RPC interface document generation.

There is a newer version: 3.0.5

/*
 * Copyright (C) 2018-2023 smart-doc
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.ly.doc.constants;

/**
 * @author yu 2019/9/21.
 */
public enum TemplateVariable {
    DESC("desc"),
    NAME("name"),
    LIST("list"),
    API_DOC_LIST("apiDocList"),
    API_DOC_LIST_ONLY_HAS_DEFAULT_GROUP("apiDocListOnlyHasDefaultGroup"),
    ERROR_CODE_LIST("errorCodeList"),
    ERROR_CODE_ORDER("errorCodeListOrder"),
    VERSION_LIST("revisionLogList"),
    DEPENDENCY_LIST("dependencyList"),
    HOME_PAGE("homePage"),
    HTML("html"),
    TITLE("title"),
    STYLE("style"),
    BACKGROUND("background"),
    ERROR_LIST_TITLE("errorListTitle"),
    CREATE_TIME("createTime"),
    PROJECT_NAME("projectName"),
    LANGUAGE("language"),
    DICT_LIST("dictList"),
    DICT_LIST_TITLE("dictListTitle"),
    DICT_ORDER("dictListOrder"),
    VERSION("version"),
    PROTOCOL("protocol"),
    AUTHOR("author"),
    URI("uri"),
    RPC_CONSUMER_CONFIG("consumerConfigExample"),
    REQUEST_EXAMPLE("isRequestExample"),
    RESPONSE_EXAMPLE("isResponseExample"),
    DISPLAY_REQUEST_PARAMS("displayRequestParams"),
    DISPLAY_RESPONSE_PARAMS("displayResponseParams"),
    RESPONSE_LIST("respList"),
    ORDER("order"),
    INDEX_ALIAS("alias"),
    DIRECTORY_TREE("directoryTree"),
    HIGH_LIGHT_CSS_LINK("highlightCssLink"),
    CSS_CND("css_cdn");

    private String variable;

    TemplateVariable(String variable) {
        this.variable = variable;
    }

    public String getVariable() {
        return this.variable;
    }
}