API documentation available

OJS development discussion, enhancement requests, third-party patches and plug-ins.

Moderators: jmacgreg, btbell, michael, bdgregg, barbarah, asmecher

Forum rules
The Public Knowledge Project Support Forum is moving to http://forum.pkp.sfu.ca

This forum will be maintained permanently as an archived historical resource, but all new questions should be added to the new forum. Questions will no longer be monitored on this old forum after March 30, 2015.
Posts: 10015
Joined: Wed Aug 10, 2005 12:56 pm

API documentation available

Postby asmecher » Mon Jul 14, 2008 12:01 pm

Hello all,

For the OJS 2.2.1 release (and subsequent releases), we're publishing API documentation at http://pkp.sfu.ca/ojs/doxygen/html/index.html. We hope this will be a useful addition to the set of documentation available for OJS. Please feel free to pass along any suggestions or errata by replying to this thread.

Alec Smecher
Public Knowledge Project Team

Posts: 113
Joined: Fri Mar 30, 2007 3:32 pm

Re: API documentation available

Postby rmichael » Mon Aug 04, 2008 2:22 am

Hi Alec,

This has been a big help, thanks for working on it.

Any chance of having all hooks listed the API? I don't know anything about doxygen, can you define custom sections of an API for it to document? It took me quite a while to figure out the dynamic hooks (e.g. UserDAO::_insertUser) were named with an "_". Our previous conversation in April discussed the hooks as "UserDAO::insertUser" without the "_", so I was confused for quite a while. :-) In the past, I grepped through the source for hooks (since the OJS TechDoc is presumably out of date now as well), but the dynamic hooks don't turn up with such a trivial effort.


Posts: 952
Joined: Mon May 05, 2008 10:29 am
Location: Vancouver, BC

Re: API documentation available

Postby mcrider » Mon Aug 04, 2008 2:51 pm

Hi Richard,

Being the one that built the latest OCS/OJS Doxygen docs, I found it pretty cumbersome to work with, e.g. Doxygen is very particular about the placement of tags and its numerous settings have to be just right to get such a large codebase to generate good documentation. That being said, it is possible to define custom tags through Doxygen, with which you could create an index page that lists all occurrences of these custom tags. Thus, one would have to go through all of the code and stick this custom tag in the comment block above each hook. This probably won't be a priority for us for some time, but as always, community contributions are appreciated!


Return to “OJS Development”

Who is online

Users browsing this forum: No registered users and 1 guest