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

2013-10-09 Thread Mike Billau (JIRA)

[ 
https://issues.apache.org/jira/browse/CB-2630?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=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)


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

2013-03-06 Thread Michael Brooks (JIRA)

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

Michael Brooks commented on CB-2630:


Interesting idea Benjamin.

We're looking into completely restructuring the documentation and navigation is 
a big component of that. I'd never considered browsing by the JavaScript 
objects (e.g. {{window.navigator}}) but I think it's a fantastic idea.

Work wouldn't be starting on this for a while, but I'll this issue around as a 
remind.

 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

 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 is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira