de.smartics.analysis.javadoc
Interface Filter

Package class diagram package Filter
All Known Implementing Classes:
AcceptAllFilter, ImplementsInterfaceFilter

public interface Filter

A filter to remove unwanted Javadoc information from a doclet.

Author:
Robert Reiner

Method Summary
 com.sun.javadoc.Doc accept(com.sun.javadoc.Doc doc)
          Filters the given Javadoc information.
 

Method Detail

accept

com.sun.javadoc.Doc accept(com.sun.javadoc.Doc doc)
Filters the given Javadoc information.

If the given argument is null, null is returned. This implies that the given information is not accepted.

Parameters:
doc - the Javadoc information to check for filtering.
Returns:
null if the element is not to accepted, an instance of Doc if is is. Note that the returned Doc may be a sub element of the Doc element passed as argument.


Copyright © 2008-2011 Kronseder & Reiner GmbH - smartics. All Rights Reserved.