com.thoughtworks.qdox.parser.CommentScanner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.fop Show documentation

The core maven build properties

The newest version!

package com.thoughtworks.qdox.parser;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

/**
 * Classes implementing this interface can trigger the handler for every time it has parsed a comment. 
 * 
 * @author Robert Scholte
 * @since 2.0
 */
public interface CommentScanner
{
    /**
     * Register this handler as a comment-listener.
     * If scanner hits a comment, all handlers will be triggered.
     * 
     * @param handler the commentHandler to add to the CommentScanner
     */
    void addCommentHandler( CommentHandler handler );
}