OJS OCS OMP OHS

You are viewing the PKP Support Forum | PKP Home Wiki



[solved] What tool are those doc comment tags for?

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

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

Forum rules
Developer Resources:

Documentation: The OJS Technical Reference and the OJS API Reference are both available from the OJS Documentation page.

Git: You can access our public Git Repository here. Comprehensive Git usage instructions are available on the wiki.

Bugzilla: You can access our Bugzilla report tracker here.

Search: You can use our Google Custom Search to search across our main website, the support forum, and Bugzilla.

Questions and discussion are welcome, but if you have a workflow or usability question you should probably post to the OJS Editorial Support and Discussion subforum; if you have a technical support question, try the OJS Technical Support subforum.

[solved] What tool are those doc comment tags for?

Postby mwood » Wed Oct 14, 2009 1:18 pm

The DocBlocks are peppered with things like @brief, @class, @file, @ingroup.

The PEAR PhpDocumentor doesn't understand them and throws many warnings. I can keep adding to my -customtags list to suppress the warnings, but I was wondering what does understand these. Do I need a different API documentation extractor?

...sorry, I read around a bit and I see they are Doxygen tags. I'm leaving this posting here in the hope of heading off another such query.
mwood
 
Posts: 20
Joined: Thu Nov 01, 2007 8:06 am
Location: Indianapolis, Indiana, US

Return to OJS Development

Who is online

Users browsing this forum: Google [Bot] and 1 guest