com.google.devtools.build.docgen.skylark.SkylarkDocUtils.java Source code

Introduction

Here is the source code for com.google.devtools.build.docgen.skylark.SkylarkDocUtils.java

Source

// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed 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.google.devtools.build.docgen.skylark;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.docgen.DocgenConsts;
import com.google.devtools.build.lib.skylarkinterface.Param;

/** A utility class for the documentation generator. */
public final class SkylarkDocUtils {
    private SkylarkDocUtils() {
    }

    /**
     * Substitute special variables in the documentation with their actual values
     *
     * @return a string with substituted variables
     */
    static String substituteVariables(String documentation) {
        return documentation.replace("$BE_ROOT", DocgenConsts.BeDocsRoot).replace("$DOC_EXT",
                DocgenConsts.documentationExtension);
    }

    /**
     * Returns a list of parameter documentation elements for a given method doc and the method's
     * parameters.
     */
    static ImmutableList<SkylarkParamDoc> determineParams(SkylarkMethodDoc methodDoc, Param[] userSuppliedParams,
            Param extraPositionals, Param extraKeywords) {
        ImmutableList.Builder<SkylarkParamDoc> paramsBuilder = ImmutableList.builder();
        for (Param param : userSuppliedParams) {
            paramsBuilder.add(new SkylarkParamDoc(methodDoc, param));
        }
        if (!extraPositionals.name().isEmpty()) {
            paramsBuilder.add(new SkylarkParamDoc(methodDoc, extraPositionals));
        }
        if (!extraKeywords.name().isEmpty()) {
            paramsBuilder.add(new SkylarkParamDoc(methodDoc, extraKeywords));
        }
        return paramsBuilder.build();
    }
}