JDK 17 jdk.javadoc.jmod - Java Document Tool

JDK 17 jdk.javadoc.jmod is the JMOD file for JDK 17 Java Document tool, which can be invoked by the "javadoc" command.

JDK 17 Java Document tool compiled class files are stored in \fyicenter\jdk-17.0.5\jmods\jdk.javadoc.jmod.

JDK 17 Java Document tool compiled class files are also linked and stored in the \fyicenter\jdk-17.0.5\lib\modules JImage file.

JDK 17 Java Document tool source code files are stored in \fyicenter\jdk-17.0.5\lib\src.zip\jdk.javadoc.

You can click and view the content of each source code file in the list below.

✍: FYIcenter

jdk/javadoc/internal/doclets/toolkit/MemberSummaryWriter.java

/*
 * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package jdk.javadoc.internal.doclets.toolkit;

import java.util.*;

import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;

import com.sun.source.doctree.DocTree;

/**
 * The interface for writing member summary output.
 *
 *  <p><b>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.</b>
 */

public interface MemberSummaryWriter {

    /**
     * Returns the member summary header for the given class.
     *
     * @param typeElement       the class the summary belongs to
     * @param memberSummaryTree the content tree to which the member summary will be added
     *
     * @return a content tree for the member summary header
     */
    Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree);

    /**
     * Returns the summary table for the given class.
     *
     * @param typeElement the class the summary table belongs to
     *
     * @return a content tree for the member summary table
     */
    Content getSummaryTableTree(TypeElement typeElement);

    /**
     * Adds the member summary for the given class and member.
     *
     * @param typeElement        the class the summary belongs to
     * @param member             the member that is documented
     * @param firstSentenceTrees the tags for the sentence being documented
     */
    void addMemberSummary(TypeElement typeElement, Element member,
                          List<? extends DocTree> firstSentenceTrees);

    /**
     * Returns the inherited member summary header for the given class.
     *
     * @param typeElement the class the summary belongs to
     *
     * @return a content tree containing the inherited summary header
     */
    Content getInheritedSummaryHeader(TypeElement typeElement);

    /**
     * Adds the inherited member summary for the given class and member.
     *
     * @param typeElement the class the inherited member belongs to
     * @param member the inherited member that is being documented
     * @param isFirst true if this is the first member in the list
     * @param isLast true if this is the last member in the list
     * @param linksTree the content tree to which the links will be added
     */
    void addInheritedMemberSummary(TypeElement typeElement,
                                   Element member, boolean isFirst, boolean isLast,
                                   Content linksTree);

    /**
     * Returns the inherited summary links.
     *
     * @return a content tree containing the inherited summary links
     */
    Content getInheritedSummaryLinksTree();

    /**
     * Adds the given summary to the list of summaries.
     *
     * @param summariesList the list of summaries
     * @param content       the summary
     */
    void addSummary(Content summariesList, Content content);

    /**
     * Returns the member tree.
     *
     * @param memberTree the content tree representing the member
     *
     * @return a content tree for the member
     */
    Content getMemberTree(Content memberTree);
}

jdk/javadoc/internal/doclets/toolkit/MemberSummaryWriter.java

 

Or download all of them as a single archive file:

File name: jdk.javadoc-17.0.5-src.zip
File size: 587730 bytes
Release date: 2022-09-13
Download 

 

JDK 17 jdk.jcmd.jmod - JCmd Tool

JDK 17 jdk.jartool.jmod - JAR Tool

JDK 17 JMod/Module Files

⇑⇑ FAQ for JDK (Java Development Kit) 17

2023-08-17, 6972👍, 0💬