dpogue opened a new pull request, #1476:
URL: https://github.com/apache/cordova-ios/pull/1476

   ### Platforms affected
   iOS
   
   
   ### Motivation and Context
   <!-- Why is this change required? What problem does it solve? -->
   <!-- If it fixes an open issue, please link to the issue here. -->
   The API available to people embedding CordovaLib as a framework in their 
existing apps is not well documented, nor is the API available to plugin 
authors.
   
   With DocC comments, we can generate Apple-style documentation for our 
framework, and serve it on GitHub Pages.
   
   
   ### Description
   <!-- Describe your changes in detail -->
   Add DocC comments to some of CordovaLib and add a main page file. This is 
only an initial pass over the sections of code that I've been touching 
recently, but the goal is to have everything that's public API commented 
appropriately.
   
   
   ### Testing
   <!-- Please describe in detail how you tested your changes. -->
   Existing tests pass.
   Built documentation bundle with Xcode for local testing.
   
   
   ### Checklist
   
   - [x] I've run the tests to see all new and existing tests pass
   - [x] I've updated the documentation if necessary
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org

Reply via email to