db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (Commented) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-5464) Add easier to find links to Derby JavaDoc on the Derby web site
Date Fri, 14 Oct 2011 13:58:11 GMT

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

Kim Haase commented on DERBY-5464:

Thanks, Kristian, the Javadoc links are a very good thing to have on the Documentation page.
I am a bit puzzled, though, because in the draft page the links go to 

Engine -- http://db.apache.org/derby/javadoc/engine/
Language -- http://db.apache.org/derby/javadoc/language/
Testing -- http://db.apache.org/derby/javadoc/testing/
Tools -- http://db.apache.org/derby/javadoc/tools/

but not to the public API that would be of most use (I think?) to readers of the documentation.
Whereas on the Apache Derby Papers page (http://db.apache.org/derby/papers/index.html), the
links are to

Engine (same)
Language (same)
Tools (same)
API -- http://db.apache.org/derby/javadoc/publishedapi/

I wonder why the Testing API is not on the Papers site. Maybe it's in some other hard-to-find

Perhaps all 5 should be linked to from both Papers and Documentation? Although arguably the
published API is not strictly speaking internal, so maybe the title should just be 

Derby API Documentation

Technically, "Javadoc" (initial capital only) is (or was) a trademarked term and has to be
used as an adjective -- Sun only allowed it to be used in front of "tool" or some such word,
as I recall -- so we generally say "API documentation" instead. I wouldn't worry about leaving
"Javadoc" on the Papers page, though.

> Add easier to find links to Derby JavaDoc on the Derby web site
> ---------------------------------------------------------------
>                 Key: DERBY-5464
>                 URL: https://issues.apache.org/jira/browse/DERBY-5464
>             Project: Derby
>          Issue Type: Task
>          Components: Web Site
>    Affects Versions:
>            Reporter: Kristian Waagan
>            Assignee: Kristian Waagan
>            Priority: Minor
>         Attachments: derby-5464-javadoc_links.diff, index-1a.html
> Add links to the Derby JavaDocs, which we do publish on the Derby web site.
> They can currently be found under Resources -> Papers -> Engine -> JavaDoc,
but I'm proposing we add links to them under Documentation.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


View raw message