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