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

Rick Hillegas commented on DERBY-6829:
--------------------------------------

Thanks for that great feedback, Bryan. The javadoc for SimpleJsonVTI can be 
found in this public api package: org.apache.derby.optional.api. I will add 
signatures for readArrayFromString(), readArrayFromFile(), and
readArrayFromURL() to the Tools documentation for the simpleJSON tool.

Making the Tools Guide link directly to the public api javadoc is a harder 
problem. I'm reluctant to add links to an absolute address because that would 
be something which would have to be updated for every release. Adding a link to 
a relative address is also awkward, for this reason: the relative paths are 
different, depending on whether you are navigating from the directory structure 
of an unpacked Derby distribution or from the the directory structure of the 
Derby documentation page. Other suggestions?

Thanks,
-Rick

> Document the simpleJson optional tool and the SimpleJsonVTI.
> ------------------------------------------------------------
>
>                 Key: DERBY-6829
>                 URL: https://issues.apache.org/jira/browse/DERBY-6829
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.12.0.0
>            Reporter: Rick Hillegas
>             Fix For: 10.12.0.0
>
>         Attachments: derby-6829-01-aa-optionalToolsSection.diff, 
> derby-6829-01-ab-reviewCorrections.diff, derby-6829-01-ac-fixTypo.diff, 
> rtoolsoptsimplejson.html, rtoolsoptsimplejson.html, rtoolsoptsimplejson.html
>
>
> We should document how to use the simple JSON functions introduced by 
> DERBY-6825.



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

Reply via email to