You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@cordova.apache.org by "Mike Billau (JIRA)" <ji...@apache.org> on 2013/10/09 22:18:41 UTC

[jira] [Commented] (CB-2630) Add API browser to documentation

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

Mike Billau commented on CB-2630:
---------------------------------

Would this be done "automatically" if we used a tool like JSDoc? 

> Add API browser to documentation
> --------------------------------
>
>                 Key: CB-2630
>                 URL: https://issues.apache.org/jira/browse/CB-2630
>             Project: Apache Cordova
>          Issue Type: Improvement
>          Components: Docs
>            Reporter: Benjamin
>            Assignee: Michael Brooks
>            Priority: Critical
>              Labels: documentation
>             Fix For: Master
>
>
> As a new user, browsing documentation by feature is fantastic, but it's difficult to find things when I want to look at the API by object hierarchy. For example, you should be able to see a list of all methods on "navigator" by platform. Something like http://docs.phonegap.com/en/2.5.0/_index.html is somewhat useful, but you cannot drill down into the API and many things aren't listed (navigator.app.loadUrl, for example).



--
This message was sent by Atlassian JIRA
(v6.1#6144)