jackrabbit-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Julian Reschke (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (JCR-4355) Javadoc fixes and improvements for new direct binary access API
Date Fri, 10 Aug 2018 11:56:00 GMT

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

Julian Reschke commented on JCR-4355:
-------------------------------------

[^JCR-4355-jr.diff]
 * attempts to clarify the charset issue
 * reduces the amount of @link tags having in-line prose (which I find confusing to read)
 * moves the note about non-http URIs to a more generic place
 * improves linking to "upload algorithm"

> Javadoc fixes and improvements for new direct binary access API
> ---------------------------------------------------------------
>
>                 Key: JCR-4355
>                 URL: https://issues.apache.org/jira/browse/JCR-4355
>             Project: Jackrabbit Content Repository
>          Issue Type: Improvement
>          Components: jackrabbit-api
>            Reporter: Alexander Klimetschek
>            Assignee: Julian Reschke
>            Priority: Major
>             Fix For: 2.18
>
>         Attachments: JCR-4355-jr.diff, JCR-4355-v2-javadoc-html.zip, JCR-4355-v2.patch,
JCR-4355.diff
>
>
> Here are some changes to the javadocs for the new API: [OAK-7569-api-javadoc-improvements.patch|https://issues.apache.org/jira/secure/attachment/12934364/12934364_OAK-7569-api-javadoc-improvements.patch]
> * more concise descriptions
> * correcting some inaccuracies (clients cannot choose whether to do single or multipart
upload, multipart might be strictly required depending on the size)
> * most importantly the upload algorithm (standard partSize calculation was wrong)
> * focus on API users, separated notes to implementors
> * for BinaryDownloadOptions added note from which jcr properties a client would normally
take these values from
> * added security considerations



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message