Class DeprecatedListWriter


  • @Deprecated
    public class DeprecatedListWriter
    extends SubWriterHolderWriter
    Deprecated.
    Generate File to list all the deprecated classes and class members with the appropriate links.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    Author:
    Atul M Dambalkar, Bhavesh Patel (Modified)
    See Also:
    List
    • Method Detail

      • generate

        public static void generate​(ConfigurationImpl configuration)
        Deprecated.
        Get list of all the deprecated classes and members in all the Packages specified on the Command Line. Then instantiate DeprecatedListWriter and generate File.
        Parameters:
        configuration - the current configuration of the doclet.
      • generateDeprecatedListFile

        protected void generateDeprecatedListFile​(DeprecatedAPIListBuilder deprapi)
                                           throws IOException
        Deprecated.
        Generate the deprecated API list.
        Parameters:
        deprapi - list of deprecated API built already.
        Throws:
        IOException
      • getContentsList

        public Content getContentsList​(DeprecatedAPIListBuilder deprapi)
        Deprecated.
        Get the contents list.
        Parameters:
        deprapi - the deprecated list builder
        Returns:
        a content tree for the contents list
      • getHeader

        public HtmlTree getHeader()
        Deprecated.
        Get the header for the deprecated API Listing.
        Returns:
        a content tree for the header