Documentation and API stabilization

Discuss about Group-Office development here

Moderator: Developers

glemigh
Posts: 28
Joined: Wed Aug 24, 2005 10:22 pm
Location: Venice, FL

Documentation and API stabilization

Postby glemigh » Thu May 15, 2014 5:28 pm

Sorry to bother you with this, but in light of Group-Office 6.x.x on the horizon would you be able to elaborate on when the Group-Office API would stabilize and when documentation for it will be made available.

Thank you,

George
richarddodd
Posts: 66
Joined: Fri Jun 21, 2013 2:55 pm

Re: Documentation and API stabilization

Postby richarddodd » Fri May 16, 2014 5:11 pm

I'm looking forward to namespaces, but converting old code is going to be a pain! :)
mschering
Site Admin
Site Admin
Posts: 8325
Joined: Tue Apr 20, 2004 1:06 pm
Location: The Netherlands - Den Bosch
Contact:

Re: Documentation and API stabilization

Postby mschering » Mon May 19, 2014 3:11 pm

We have some more changes planned. Like accepting JSON requests and paramterized actions. When that's done we'll write the docs too.
Best regards,

Merijn Schering
Intermesh
glemigh
Posts: 28
Joined: Wed Aug 24, 2005 10:22 pm
Location: Venice, FL

Re: Documentation and API stabilization

Postby glemigh » Mon May 19, 2014 5:59 pm

Nice to know you are getting close.

In the meantime I am trying to produce some documentation for Group-Office to make my coding experience less stressful by using phpDocumentor, it's complaining about some things, so that begs the question: What documentation generation tool did you tailor your in-line documentation for if any?

Thank you.

George
richarddodd
Posts: 66
Joined: Fri Jun 21, 2013 2:55 pm

Re: Documentation and API stabilization

Postby richarddodd » Thu May 22, 2014 12:12 pm

I've had success with apigen. It can be accessed directly from Netbeans (my IDE of choice for GO).
richarddodd
Posts: 66
Joined: Fri Jun 21, 2013 2:55 pm

Re: Documentation and API stabilization

Postby richarddodd » Thu May 22, 2014 12:13 pm

doxygen also works (tested)

Note that there are no namespaces, so I basically navigate using the search bar to look for classes
glemigh
Posts: 28
Joined: Wed Aug 24, 2005 10:22 pm
Location: Venice, FL

Re: Documentation and API stabilization

Postby glemigh » Thu May 22, 2014 6:54 pm

phpDocumentor was taking over a day to run, and I am using Doxygen now, I'll have a peek at ApiGen though.

I ran DoxyGen against Group-Office 6 and since GO6 has namespaces it was informative.

Who is online

Users browsing this forum: No registered users and 0 guests

cron