[
https://issues.apache.org/jira/browse/LENS-9?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14227394#comment-14227394
]
Rajat Khandelwal edited comment on LENS-9 at 11/27/14 8:56 AM:
---------------------------------------------------------------
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format
I propose that let's make description start from the same line. Descriptions
can be aligned for better readability. This will reduce number of lines in the
code. Also let's not wrap inline comments.
{code}
* @param i short named parameter description
* @param longParameterName long named parameter description
* @param missingDescription
* @return return description.
* @throws XXXException description.
* @throws YException description.
* @throws ZException
* @invalidTag
{code}
{code}
/** One-line comment */
{code}
was (Author: prongs):
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format
I propose that let's make description start from the same line. This will
reduce number of lines in the code. Also let's not wrap inline comments.
{code}
* @param i short named parameter description
* @param longParameterName long named parameter description
* @param missingDescription
* @return return description.
* @throws XXXException description.
* @throws YException description.
* @throws ZException
* @invalidTag
{code}
{code}
/** One-line comment */
{code}
> Checkstyle/Findbugs violations in code
> --------------------------------------
>
> Key: LENS-9
> URL: https://issues.apache.org/jira/browse/LENS-9
> Project: Apache Lens
> Issue Type: Improvement
> Components: build, test
> Reporter: Srikanth Sundarrajan
> Priority: Minor
> Fix For: 2.0
>
>
> There are a few checkstyle violations in code. It would help to eliminate at
> least the ones that are potentially critical. It would in general makes
> things better if all of them are addressed and we enable failOnValidation.
> Also it looks like findbugs isn't enabled.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
