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

Maxim Muzafarov commented on CASSANDRA-18717:
---------------------------------------------

[~e.dimitrova]

The same problem exists for the checkstyle rules - they are configured but are 
not highlighted in the IDE. Currently, each developer solves this thing locally 
by himself, but I think we need a more common approach here. We can highlight 
these problems with the modern IDE we support and make them visible right in 
the opened window. For example, in the IntelliJ IDEA it is called - Inspections 
(see the "severity" field on the screenshot here [1]).

>From my point of view, this problem consists of two steps: 

- We need to put the IntelliJ IDEA workspace configuration under the .idea 
directory in the project root to make this configuration shareable. The 
generate-idea-files is good for the first initialization of the project, but if 
we want to slightly adjust the configuration files (e.g. increase the severity 
level of a certain lint) it will erase all locally stored workspace 
configuration. A more detailed description of the problem and how to fix it can 
be found here: CASSANDRA-18277
- We need to configure and store the inspection configuration in the .idea 
directory and increase the severity level of a certain javadoc rule up to the 
"error" level, so a problem class is directly highlighted and visible in the 
working window. 

[1] https://www.jetbrains.com/help/idea/code-inspection.html

> Fix errors or remove ant javadoc task
> -------------------------------------
>
>                 Key: CASSANDRA-18717
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-18717
>             Project: Cassandra
>          Issue Type: Bug
>          Components: Documentation/Javadoc
>            Reporter: Ekaterina Dimitrova
>            Assignee: Maxim Muzafarov
>            Priority: Normal
>             Fix For: 5.0.x, 5.x
>
>          Time Spent: 50m
>  Remaining Estimate: 0h
>
> As discussed on CASSANDRA-17687, the javadoc task completes successfully, but 
> there are errors that deserve to be fixed if we keep the task around.
> If we do not plan to use it, we should remove it and reduce the clutter. 



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org

Reply via email to