001package org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import javax.inject.Named;
023import javax.inject.Singleton;
024
025import org.apache.maven.tools.plugin.extractor.annotations.converter.ConverterContext;
026import org.apache.maven.tools.plugin.extractor.annotations.converter.tag.LinkUtils;
027
028/**
029 * Supports <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html#link">
030 * inline link tag</a>.
031 */
032@Named( "link" )
033@Singleton
034public class LinkTagToHtmlConverter
035    extends JavadocInlineTagToHtmlConverter
036{
037    @Override
038    public String convert( String text, ConverterContext context )
039    {
040        return LinkUtils.createLink( text, context, LinkTagToHtmlConverter::decorateLinkLabel );
041    }
042
043    /**
044     * Encloses the given label in {@code code} HTML tags.
045     * 
046     * @param label
047     * @return
048     */
049    static String decorateLinkLabel( String label )
050    {
051        return "<code>" + label + "</code>";
052    }
053
054}