[ 
https://issues.apache.org/jira/browse/TEZ-4694?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18066706#comment-18066706
 ] 

László Bodor commented on TEZ-4694:
-----------------------------------

merged to master, thanks [~lewismc] for taking care of this!

> 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
>            Priority: Minor
>             Fix For: 1.0.0
>
>          Time Spent: 1.5h
>  Remaining Estimate: 0h
>
> 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)

Reply via email to