View Javadoc
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  import org.apache.maven.tools.plugin.extractor.annotations.converter.tag.LinkUtils;
26  
27  /**
28   * Supports <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#link">
29   * inline link tag</a>.
30   */
31  @Named("link")
32  @Singleton
33  public class LinkTagToHtmlConverter extends JavadocInlineTagToHtmlConverter {
34      @Override
35      public String convert(String text, ConverterContext context) {
36          return LinkUtils.createLink(text, context, LinkTagToHtmlConverter::decorateLinkLabel);
37      }
38  
39      /**
40       * Encloses the given label in {@code code} HTML tags.
41       *
42       * @param label
43       * @return
44       */
45      static String decorateLinkLabel(String label) {
46          return "<code>" + label + "</code>";
47      }
48  }