/*
 * [CommentJavadoc.java]
 *
 * Summary: Describes one slash-star-star Javadoc type Comment token for display, single line. May not contain \n!.
 *
 * 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;

import com.mindprod.jtokens.Comment;

import java.awt.Color;

import static com.mindprod.jtokens.TokenColourScheme.JAVA_FOREGROUND_FOR_JAVADOC_COMMENT;

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

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

    /**
     * foreground colour to render this token.
     *
     * @return Color object.
     */
    public Color getForeground()
        {
        return JAVA_FOREGROUND_FOR_JAVADOC_COMMENT;
        }

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