ThemisXAnalysisNodeComment.java

/*
 * Themis: Java Project Framework
 * Copyright 2012-2026. Tony Washer
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License.  You may obtain a copy
 * of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package io.github.tonywasher.joceanus.themis.xanalysis.parser.node;

import com.github.javaparser.ast.comments.Comment;
import io.github.tonywasher.joceanus.oceanus.base.OceanusException;
import io.github.tonywasher.joceanus.themis.xanalysis.parser.base.ThemisXAnalysisParserDef;

/**
 * Comment.
 */
public class ThemisXAnalysisNodeComment
        extends ThemisXAnalysisBaseNode<Comment> {
    /**
     * Constructor.
     *
     * @param pParser  the parser
     * @param pComment the comment
     * @throws OceanusException on error
     */
    ThemisXAnalysisNodeComment(final ThemisXAnalysisParserDef pParser,
                               final Comment pComment) throws OceanusException {
        super(pParser, pComment);
    }

    /**
     * Is this a javaDoc comment.
     *
     * @return true/false
     */
    public boolean isJavaDoc() {
        return getNode().isJavadocComment();
    }
}