< prev index next >

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/ClassWriter.java

Print this page


   1 /*
   2  * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  56      *
  57      * @return class content header that needs to be added to the documentation
  58      */
  59     public Content getClassContentHeader();
  60 
  61     /**
  62      * Add the class tree documentation.
  63      *
  64      * @param classContentTree class content tree to which the documentation will be added
  65      */
  66     public void addClassTree(Content classContentTree);
  67 
  68     /**
  69      * Get the class information tree header.
  70      *
  71      * @return class informaion tree header that needs to be added to the documentation
  72      */
  73     public Content getClassInfoTreeHeader();
  74 
  75     /**
  76      * Add the type parameter information.
  77      *
  78      * @param classInfoTree content tree to which the documentation will be added
  79      */
  80     public void addTypeParamInfo(Content classInfoTree);
  81 
  82     /**
  83      * Add all super interfaces if this is an interface.
  84      *
  85      * @param classInfoTree content tree to which the documentation will be added
  86      */
  87     public void addSuperInterfacesInfo(Content classInfoTree);
  88 
  89     /**
  90      * Add all implemented interfaces if this is a class.
  91      *
  92      * @param classInfoTree content tree to which the documentation will be added
  93      */
  94     public void addImplementedInterfacesInfo(Content classInfoTree);
  95 
  96     /**
  97      * Add all the classes that extend this one.
  98      *
  99      * @param classInfoTree content tree to which the documentation will be added
 100      */


   1 /*
   2  * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any


  56      *
  57      * @return class content header that needs to be added to the documentation
  58      */
  59     public Content getClassContentHeader();
  60 
  61     /**
  62      * Add the class tree documentation.
  63      *
  64      * @param classContentTree class content tree to which the documentation will be added
  65      */
  66     public void addClassTree(Content classContentTree);
  67 
  68     /**
  69      * Get the class information tree header.
  70      *
  71      * @return class informaion tree header that needs to be added to the documentation
  72      */
  73     public Content getClassInfoTreeHeader();
  74 
  75     /**
  76      * Add the type parameter and state component information.
  77      *
  78      * @param classInfoTree content tree to which the documentation will be added
  79      */
  80     public void addParamInfo(Content classInfoTree);
  81 
  82     /**
  83      * Add all super interfaces if this is an interface.
  84      *
  85      * @param classInfoTree content tree to which the documentation will be added
  86      */
  87     public void addSuperInterfacesInfo(Content classInfoTree);
  88 
  89     /**
  90      * Add all implemented interfaces if this is a class.
  91      *
  92      * @param classInfoTree content tree to which the documentation will be added
  93      */
  94     public void addImplementedInterfacesInfo(Content classInfoTree);
  95 
  96     /**
  97      * Add all the classes that extend this one.
  98      *
  99      * @param classInfoTree content tree to which the documentation will be added
 100      */


< prev index next >