[jira] [Updated] (SOLR-7516) Improve javadocs for JavaBinCodec, ObjectResolver and enforce the single-usage policy

["Shalin Shekhar Mangar (JIRA)" <ji...@apache.org>]

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

Shalin Shekhar Mangar updated SOLR-7516:
----------------------------------------
    Attachment: SOLR-7516.patch

Fixed javadoc formatting and a typo s/suported/supported. Also changed the javadoc of the returned value of ObjectResolver#resolve to say.
{code}
* @return the object {@code o} itself if it could not be serialized, or {@code null} if the whole object was successfully serialized.
{code}

> Improve javadocs for JavaBinCodec, ObjectResolver and enforce the single-usage policy
> -------------------------------------------------------------------------------------
>
>                 Key: SOLR-7516
>                 URL: https://issues.apache.org/jira/browse/SOLR-7516
>             Project: Solr
>          Issue Type: Improvement
>          Components: search
>            Reporter: Shalin Shekhar Mangar
>            Priority: Minor
>              Labels: difficulty-easy, newdev
>             Fix For: 5.2, master
>
>         Attachments: SOLR-7516.patch, SOLR-7516.patch
>
>
> The Javadocs of this class can use some improvements. It doesn't adequately describe the purpose of the ObjectResolver. Also, since it says that this object should be used only once for marshalling or unmarshalling operation, we should enforce it in code via asserts and/or exceptions.



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

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org