Github user mattf-horton commented on a diff in the pull request:
https://github.com/apache/incubator-metron/pull/414#discussion_r95617845
--- Diff:
metron-analytics/metron-profiler-client/src/main/java/org/apache/metron/profiler/client/stellar/GetProfile.java
---
@@ -132,36 +157,26 @@
private static final Logger LOG =
LoggerFactory.getLogger(GetProfile.class);
- /**
- * A client that can retrieve profile values.
- */
+ // Cached client that can retrieve profile values.
--- End diff --
Um, you got me. Perhaps my IDE "helped" me with this one. Since the
member variable being documented is private, there was no real reason to switch
to a Javadoc-style comment. The point of the edit was to add the word "cached"
to the comment. If I make any other tweaks, I'll change it back to a "//"
comment.
There is a rule, which is that Javadoc comments should be used with public
interfaces, and it doesn't matter which you use with private interfaces, altho
no harm in using the Javadocs format if you want the documentation of a private
i/f to be really clear.
---
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.
---
