API Documentation

Development Forum for the API Documentation Tool.
Post Reply
cloutiy
Posts: 13
Joined: Wed Jul 20, 2016 5:07 pm

API Documentation

Post by cloutiy »

Hello,

Regarding API documentation...can anyone share how to get to it?

Where is it located? In the IDE Help section I can get to a documentation folder in which the Tao of Ecere pdf is located in, as well as a couple of other documents - which I suspect is what I'm looking for.

However what do I use to open those documents?

Regards,

yves
cloutiy
Posts: 13
Joined: Wed Jul 20, 2016 5:07 pm

Re: API Documentation

Post by cloutiy »

Nevermind, I was able to find it by pressing F1.

Thanks!
jerome
Site Admin
Posts: 603
Joined: Sat Jan 16, 2010 11:16 pm

Re: API Documentation

Post by jerome »

Hi Yves,

For the API Reference (and I imagine you are talking about the .eCdoc files), you can simply press 'F1' in the IDE or select Help / API Reference in the menus. Alternatively you can launch 'documentor'.

Unfortunately, as you will soon find out the API docs are still missing a lot of contents and even the contents that is there has not been reviewed.

One big improvement that the upcoming release brings is the transition from those binary .eCdoc files (they are acually 'ear' archives) to ECON text format. This will facilitate tracking documentation changes through Git and should really help finally sitting down and improving the documentation.

Although it is already very valuable as a quick & up-to-date API listing (Classes, Methods, Properties, parameters, etc...), one of the best source of information at this point remains the samples, and the community (don't hesitate to ask for help here or on IRC, and do ping me if something goes unanswered for more than 24 hours).

Best regards,

-Jerome
Post Reply