/*
 * [CommentJavadocTag.java]
 *
 * Summary: Describes one @xxxx token is inside a Javadoc type Comment.
 *
 * Copyright: (c) 2004-2017 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.8+
 *
 * Created with: JetBrains IntelliJ IDEA IDE http://www.jetbrains.com/idea/
 *
 * Version History:
 *  2.0 2009-04-19 tidy comments, more accurate colour names
 */
package com.mindprod.jtokens.java;

/**
 * Describes one @xxxx token is inside a Javadoc type Comment.
 * <p/>
 * May not contain \n!.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 2.0 2009-04-19 tidy comments, more accurate colour names
 * @since 2004-04-24
 */
public final class CommentJavadocTag extends CommentJavadoc
    {
    /**
     * version number for the class
     */
    static final long serialVersionUID = 1L;

    /**
     * Constructor
     *
     * @param comment text including delimiters, including possible lead star or @ -- exactly as written.
     *                but no embedded \n
     */
    public CommentJavadocTag( String comment )
        {
        super( comment );
        }
    // colour inherited from javadoc

    /**
     * get the text surrounded by CSS html
     *
     * @return decorated HTML in a <span sandwich
     */
    public String getHTML()
        {
        return "<span class=\"javadoctag\">" + getRawHTML() + "</span>";
        }
    }