I think it is useful to make indicate WHY the class even created at the first place and what would be direct relationship to other classes.
- Henry On Fri, Jun 19, 2015 at 2:36 PM, jwang47 <[email protected]> wrote: > Github user jwang47 commented on a diff in the pull request: > > https://github.com/apache/incubator-twill/pull/45#discussion_r32871559 > > --- Diff: > twill-yarn/src/main/hadoop21/org/apache/twill/internal/yarn/Hadoop21YarnAppClient.java > --- > @@ -46,7 +46,12 @@ > import javax.annotation.Nullable; > > /** > + * <p> > + * The service implementation of {@link YarnAppClient} for Apache Hadoop > 2.1 and beyond. > * > + * The {@link VersionDetectYarnAppClientFactory} class will decided to > return instance of this class for > --- End diff -- > > Seems it may be overkill to also document usages of the class? > > > --- > If your project is set up for it, you can reply to this email and have your > reply appear on GitHub as well. If your project does not have this feature > enabled and wishes so, or if the feature is enabled but not working, please > contact infrastructure at [email protected] or file a JIRA ticket > with INFRA. > ---
