ydoc.filters
Interface DocFilter

All Known Implementing Classes:
ydoc.filters.ExcludeFilter
public interface DocFilter

To be loaded and used by doclets at run-time, the doc filter must have a static method called register that accepts a List as an argument with the following signature:

public static void register(List list)
This method should add an instance of the custom doc filter to the list.
It is recommended that the filter throws an exception when it fails to register itself. The exception that it throws is up to the user.

 

Method Summary
 boolean accept(Doc doc)
          Tests whether or not the specified documentation element should be included in the generated API documentation.
 

Method Detail

accept

public boolean accept(Doc doc)
Tests whether or not the specified documentation element should be included in the generated API documentation.

Parameters:
doc - The documentation element to be tested.
Returns:
true if and only if the documentation element should be included; false otherwise.