1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline;
20
21 import javax.inject.Named;
22 import javax.inject.Singleton;
23
24 import org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext;
25
26 /**
27 * Supports <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#docroot">
28 * docRoot value tag</a>.
29 */
30 @Named("docRoot")
31 @Singleton
32 public class DocRootTagConverter extends JavadocInlineTagToHtmlConverter {
33 @Override
34 public String convert(String text, ConverterContext context) {
35 return context.getInternalJavadocSiteBaseUrl().toString();
36 }
37 }