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

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

To me, the most important obligation we have is to provide users with a good 
view of Cassandra internals by making the javadocs available on the web. Many 
important things are only mentioned in the javadocs, but not in the 
documentation. This is not a bad thing, as it is up to the user how deep they 
want to go.

If we want the javadocs to be a part of the documentation, and to be available 
with every new release, it should at least be compilable. This is even more 
important when new CEPs that come into play.

And now we have two ways to go: either every commit has compilable javadocs, or 
we fix them all before releasing a new version. So, I've assumed here, that 
we've chosen the first one, right?

> 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: 0.5h
>  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