[
https://issues.apache.org/jira/browse/TEZ-1436?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14104966#comment-14104966
]
Jonathan Eagles commented on TEZ-1436:
--------------------------------------
For methods that use method chaining where the return is of the type
{code}
return this;
{code}
I think we should prefer documenting it with at least the word this. This has
no special meaning to javadoc. However, it conveys to the reader that the same
object (as opposed to a copy!) is returned. It also documents the method can be
chained properly.
My personal though not strong preference is that there is no need to link to
the class itself in the return since the method signature will already have the
class link. As a reference, the Java api itself does
{code}
/*
* @return this {@code classname}
*/
{code}
which does not provide a link but does give some emphasis on the classname
> Fix javadoc warnings
> --------------------
>
> Key: TEZ-1436
> URL: https://issues.apache.org/jira/browse/TEZ-1436
> Project: Apache Tez
> Issue Type: Bug
> Reporter: Hitesh Shah
> Assignee: Jonathan Eagles
> Attachments: TEZ-1436-v1.patch
>
>
--
This message was sent by Atlassian JIRA
(v6.2#6252)
