diff options
author | 2017-12-18 06:42:21 -0800 | |
---|---|---|
committer | 2017-12-18 06:44:20 -0800 | |
commit | 1892677145c55f3e233a5dd16c695416b994a924 (patch) | |
tree | 2fded39087e5d5a2cffe053f4258fb643ede8212 /src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java | |
parent | 2f10da0db062e023b1f0f8222f8545467b29ae4e (diff) |
Fix a documentation link
PiperOrigin-RevId: 179416493
Diffstat (limited to 'src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java')
-rw-r--r-- | src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java new file mode 100644 index 0000000000..ac73f65596 --- /dev/null +++ b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java @@ -0,0 +1,33 @@ +// 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.devtools.build.docgen.DocgenConsts; + +/** 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); + } +} |