You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@tez.apache.org by "Lewis John McGibbney (Jira)" <ji...@apache.org> on 2026/03/16 22:47:00 UTC

[jira] [Created] (TEZ-4694) Add package-level Javadoc descriptions so generated API docs show a short summary for each package

Lewis John McGibbney created TEZ-4694:
-----------------------------------------

             Summary: Add package-level Javadoc descriptions so generated API docs show a short summary for each package
                 Key: TEZ-4694
                 URL: https://issues.apache.org/jira/browse/TEZ-4694
             Project: Apache Tez
          Issue Type: Improvement
    Affects Versions: 0.10.5
            Reporter: Lewis John McGibbney
            Assignee: Lewis John McGibbney
             Fix For: 1.0.0


Currently package-level summaries should come from Javadoc comments in {{{}package-info.java{}}}. There are 48 such files today; they only have license and annotations and no package description. Several API packages have no {{package-info.java}} at all.

This ticket will address these shortcomings so the Javadoc provide more context.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)