src/jdk.javadoc/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package-info.java

Print this page




  31     doclets.  Each doclet must have a taglet writer that takes a taglet
  32     as input and writes doclet-dependent output. The taglet itself will
  33     do the tag processing. For example, suppose we are outputing
  34     @throws tags. The taglet would:
  35     <ul>
  36         <li> Retrieve the list of throws tags to be documented.
  37         <li> Replace {&#64;inheritDoc} with the appropriate documentation.
  38         <li> Add throws documentation for exceptions that are declared in
  39              the signature of the method but
  40              not documented with the throws tags.
  41     </ul>
  42     After doing the steps above, the taglet would pass the information to
  43     the taglet writer for writing. The taglets are essentially builders for
  44     tags.
  45 
  46     <p><b>This is NOT part of any supported API.
  47     If you write code that depends on this, you do so at your own risk.
  48     This code and its internal interfaces are subject to change or
  49     deletion without notice.</b>
  50 */

  51 package com.sun.tools.doclets.internal.toolkit.taglets;


  31     doclets.  Each doclet must have a taglet writer that takes a taglet
  32     as input and writes doclet-dependent output. The taglet itself will
  33     do the tag processing. For example, suppose we are outputing
  34     &#64;throws tags. The taglet would:
  35     <ul>
  36         <li> Retrieve the list of throws tags to be documented.
  37         <li> Replace {&#64;inheritDoc} with the appropriate documentation.
  38         <li> Add throws documentation for exceptions that are declared in
  39              the signature of the method but
  40              not documented with the throws tags.
  41     </ul>
  42     After doing the steps above, the taglet would pass the information to
  43     the taglet writer for writing. The taglets are essentially builders for
  44     tags.
  45 
  46     <p><b>This is NOT part of any supported API.
  47     If you write code that depends on this, you do so at your own risk.
  48     This code and its internal interfaces are subject to change or
  49     deletion without notice.</b>
  50 */
  51 
  52 package com.sun.tools.doclets.internal.toolkit.taglets;