Where is API Documentation?

Discussion of the documentation project.
Locked
wasp

Where is API Documentation?

Post by wasp »

Ted
Power Poster
Power Poster
Posts: 3329
Joined: Fri Jun 11, 2004 6:58 pm
Location: Fairless Hills, Pa USA

Re: Where is API Documentation?

Post by Ted »

Well, the best we have right now is: http://cmsmadesimple.org/apidoc/

The CMSModule class has all of the methods you can override and what they do.

We'll come up with something better a little later on.  Also, the skeleton module is great for seeing the basics of how to use the API.
Ted
Power Poster
Power Poster
Posts: 3329
Joined: Fri Jun 11, 2004 6:58 pm
Location: Fairless Hills, Pa USA

Re: Where is API Documentation?

Post by Ted »

I've rerun it since then, but I still think it's 0.13.  Let me see what I can do about updating it for the latest release.
Ted
Power Poster
Power Poster
Posts: 3329
Joined: Fri Jun 11, 2004 6:58 pm
Location: Fairless Hills, Pa USA

Re: Where is API Documentation?

Post by Ted »

I've just rerun it for 1.0.2.  You should be good to go.
musicscore
Power Poster
Power Poster
Posts: 444
Joined: Wed Jan 25, 2006 11:53 am
Location: Netherlands

[Solved] Where is API Documentation?

Post by musicscore »

The Api documentation is still not working correctly. When I click on a function, I get an error.
This documentation is very usefull, especialy when you, just like me, trying to write your first module.

Is there a link to a working apidoc page ?

Thanx,

Musicscore
Last edited by musicscore on Thu Jun 17, 2010 12:59 pm, edited 1 time in total.
Jos
Support Guru
Support Guru
Posts: 4017
Joined: Wed Sep 05, 2007 8:03 pm
Location: The Netherlands

Re: Where is API Documentation?

Post by Jos »

Click on CMSModule first, then just work with the screen on the right
musicscore
Power Poster
Power Poster
Posts: 444
Joined: Wed Jan 25, 2006 11:53 am
Location: Netherlands

Re: Where is API Documentation?

Post by musicscore »

Thanx Jos,

for this very quick response.
Maybe now I will win the battle with my first created cmsmodule.

Musicscore
janieblue
New Member
New Member
Posts: 2
Joined: Mon Jun 28, 2010 11:16 am

Re: Where is API Documentation?

Post by janieblue »

hello,


the http://www.cmsmadesimple.org/apidoc/ is broken, could you take a look?


kond regards,

Jana
Ted
Power Poster
Power Poster
Posts: 3329
Joined: Fri Jun 11, 2004 6:58 pm
Location: Fairless Hills, Pa USA

Re: Where is API Documentation?

Post by Ted »

Sorry about that.  It's fixed.
Locked

Return to “[locked] Documentation0ld”