Docs need an API section

[tomwayson]

Need to document API of every service/directive.

May want to wait until after #69

[jwasilgeo]

As you mention in #69, it would be great to

enable the "roll your own custom map directive" pattern

We've discussed this elsewhere, but I wanted to document here, too, that it would be great to lay out some kind of step-by-step rough guide on making custom map directives in a repeatable pattern. Perhaps those who are trying to figure out the whole Angular and Esri JSAPI 3.x integration might benefit from that.

[tomwayson]

I've also been thinking of adding a "Patterns" section or the API for a "roll your own" example as well as the lazy loading example.

[tomwayson]

This is a reminder to us to add nav links to ngdoc header via:

/~https://github.com/nikhilmodak/gulp-ngdocs#navtemplate

Nav in main site should match:

Home - / (will need to add a new /#/ route as a landing page like this)
Examples - /#/examples
API - /docs
Patterns - new /#/patterns route to replace /#/about
GitHub - /~https://github.com/Esri/angular-esri-map

[jwasilgeo]

Add comments for ngdoc-umentation API generation to:

• map/esriMap
• map/EsriMapController
• map/esriLegend

---

• layers/esriFeatureLayer
• layers/EsriFeatureLayerController
• layers/esriDynamicMapServiceLayer
• layers/EsriDynamicMapServiceLayerController
• layers/EsriLayerControllerBase
• layers/esriInfoTemplate

---

• core/esriLayerUtils
• core/esriLoader
• core/esriMapUtils
• core/esriRegistry

Do we want to document the xyzController.js controllers and xyzUtils.js services? Assuming yes for latter, not sure about former. (Answered below)

Note: Add <a> between API documentation and site examples. See how esriLegend directive and Legend example page are inter-linked to each other.

[tomwayson]

Yep, we need to doc public APIs of utils and controllers too.

[jwasilgeo]

Working on this in api-documentation branch.

[tomwayson]

FYI - core/esriLayerUtils is in the karma branch b/c I had to make some changes to that file while working on the unit tests (unit tests caught some bugs!).

[tomwayson]

@jwasil

Why don't you PR what you have so far. I want to tag a Beta 6 release soon. We'll carry on the remaining ones under a new issue in RC1 (like #146).

[tomwayson]

@jwasil I'm going to handle core/esriMapUtils as I'll be updating the actual api in #144.

[jwasilgeo]

Great! I'm hoping to get on some of this later today, but feel free to jump on this branch if you need to for anything else.

[jwasilgeo]

Continuing on branch api-docs-continued

[tomwayson]

👍

[jwasilgeo]

@tomwayson would you be down with giving some of the docs a quick overview? Some descriptions and params I wasn't completely sure about, and I just stood up the EsriLayerControllerBase and also not sure if/how we want to document _bindLayerEvents. ngdoc doesn't seem to care about any @private flags, fyi.

We're almost done with these!

[tomwayson]

great work @jwasil! I was thinking that this documentation effort was going to be be mainly copying and pasting the existing comments into ngdocs format, but after doing esriMapUtils I realized how much can be added, and I think what you've done is looking great.

If we're going to doc the layer controllers that inherit from EsriLayerControllerBase, can we just ngdoc the bindLayerEvents() in each instead of _bindLayerEvents()? I'll defer to you on that.

[jwasilgeo]

Thanks for the review and feedback! Agreed and done for the bindLayerEvents() suggestion.