cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sylvain Lebresne (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (CASSANDRA-11640) javadoc for UnfilteredSerializer is not formatted correctly
Date Tue, 03 May 2016 10:31:13 GMT

     [ https://issues.apache.org/jira/browse/CASSANDRA-11640?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Sylvain Lebresne updated CASSANDRA-11640:
-----------------------------------------
       Resolution: Fixed
    Fix Version/s:     (was: 3.x)
                   3.6
           Status: Resolved  (was: Patch Available)

The problem with the patch is that it makes that javadoc unreadable in the source code. That
javadoc is first and foremost for the C* devs and I'm pretty sure almost none of them uses
the generated html javadoc so making the html rendering looks nice is ok, but it's kind of
secondary to having it readable in the code.

But anyway, we can make it look better in html while keeping it readable so I took a shot
at this. There was also a few things that were outdated so I fixed those.

> javadoc for UnfilteredSerializer is not formatted correctly
> -----------------------------------------------------------
>
>                 Key: CASSANDRA-11640
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-11640
>             Project: Cassandra
>          Issue Type: Bug
>            Reporter: Wei Deng
>            Assignee: Wei Deng
>            Priority: Minor
>             Fix For: 3.6
>
>         Attachments: screenshot-1.png
>
>
> The javadoc for o.a.c.db.rows.UnfilteredSerializer is the most authoritative information
I was able to find that defines the structure of a Row object or a RangeTombstoneMarker object.
However, currently [it|https://github.com/apache/cassandra/blob/cassandra-3.5/src/java/org/apache/cassandra/db/rows/UnfilteredSerializer.java#L32-L70]
has a lot of incorrect usage of tags which makes its javadoc very hard to read. It should
be pretty trivial to reorganize the text so that it can follow javadoc's markup convention.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message