topic Re: Documentation in ArcGIS API for Flex Questions

Documentation

HugoDurana — Thu, 13 Jan 2011 07:45:12 GMT

Hey there.

I've been working with the API for a month now and the thing i am currently missing the most is the description of protected fields.

Could you guys and gals try to think about this either in the current 2.2 release or at least in a future release?

BTW, the API isn't that extensible... try upgrading some private methods to protected.

Thanks,
Hugo.

Re: Documentation

DasaPaddock — Thu, 13 Jan 2011 15:12:24 GMT

Can you explain what your use case is? Which class would you like to extend?

Re: Documentation

ReneRubalcava — Thu, 13 Jan 2011 15:29:58 GMT

There was a case Dasa before the latest release fixed the clearing lod issue where I could have probably worked around it by overriding the map_extentChangeHandler() of Map to check the given extent before doing a super.map_extentChangeHandler(). As far as I can tell, it's a private function.

Re: Documentation

DasaPaddock — Thu, 13 Jan 2011 15:48:16 GMT

Map doesn't have a map_extentChangeHandler() function, but if you were to extend map, you could override the setter:
override public function set extent(value:Extent):void

Re: Documentation

HugoDurana — Thu, 13 Jan 2011 19:52:47 GMT

Can you explain what your use case is? Which class would you like to extend?

Hi there Dasa.

The matter of fact is that i don't really have a use case. I wrote the post in order to get you guys at Esri to provide somewhat better documentation regarding the API.

It is my opinion that the documentation could have more information.

Regarding your second question, i answer: Everything. I should be able, as a developer, to extend from any of your classes and do whatever i please. But after extending, i get that same question everytime: What are the protected methods?

Putting it simple: I am bitchin' about the lack of documentation regarding protected and private methods.

Re: Documentation

HugoDurana — Thu, 27 Jan 2011 15:33:41 GMT

Hey there.

When are you guys going to update the documentation?

Re: Documentation

BjornSvensson — Fri, 28 Jan 2011 17:15:16 GMT

Hugo, thanks for your feedback on the documentation. We only make major changes to the documentation when we release a new version.

We don't have plans (nor resources) to document every protected method. However, we do try to document classes and methods as needed to enable users to extend the API for specific use cases. For example, symbols, renderers, layers and tasks. If there are specific additional use cases, we can help explain here on the forum as well as update the documentation if it seems to be a common use case.

Again, big thanks to everyone who gives us feedback on our documentation and API 🙂