Tag Documentation

[cboden]

Is there anywhere I can find a list of supported tags (and each tags parameters) to use while documenting my source code?

[smasty]

It looks like following annotations are supported (determined from the source code):

deprecated
category
package
subpackage
copyright
license
author
version
since
see
uses
link
internal
example
tutorial
todo
param
return
throws

And these are deprecated or unsupported (although I'm pretty sure the first four of them works)

property
property-read
property-write
method
abstract
access
final
filesource
global
name
static
staticvar

[cboden]

Thanks for the list @smasty.

I would like to request a formal documentation however, including which (if any) parameters follow these annotations.

Also, method was the annotation I had in question. I'm trying to use it as per the PHPDoc spec (magic method via __call) with no luck.

Chris Boden

On Monday, 26 September, 2011 at 2:11 PM, smasty wrote:

It looks like following annotations are supported (determined from the source code):

deprecated
category
package
subpackage
copyright
license
author
version
since
see
uses
link
internal
example
tutorial
todo
param
return
throws

And these are deprecated or unsupported (although I'm pretty sure the first four of them works)

property
property-read
property-write
method
abstract
access
final
filesource
global
name
static
staticvar

Reply to this email directly or view it on GitHub:
#62 (comment)

[Andrewsville]

Hi, thanks @smasty for the list.

Moreover ApiGen supports inline {@inheritdoc} and {@internal} tags. The syntax of particular tags should be as compatible as possible with phpDocumentor.

The unsupported tags either come from the pre-PHP5 era (abstract, access, static, final) or they are kind of meta-programming stuff (method, property, property-read, property-write). The "vanilla" ApiGen will always generate documentation that reflects the actual source code as closely as possible (a method has to be declared final to really be final, using __call does not actually create methods, etc). However in the 3 version (with the plugin support) we plan to introduce some kind of "legacy" and "meta programming" plugins.

btw This is a typical question for the mailing list, not for GitHub issues. However we are aware that ApiGen lacks documentation of its abilities and it is one of our priorities right now.

[Drachenkaetzchen]

Well, I disagree here. I also tried to find out which tags are supported, and I finally stumbled over this issue. I can't see how a mailing list is useful for documentation.

Probably this issue needs to be written as: "ApiGen lacks an overview of all supported tags on the homepage".

[mhipo1364]

Hi
I have a question
Is there any chance to make require some tags for apigen or phpdocumentor?
I mean, something like code sniffer that crawls into code and fetch files with wrong docblocks ?

[XedinUnknown]

What's been done with regard to the documentation please? It already took me a while to find the repository, as nothing on the official website suggests that documentation/turorial is on GitHub. Where can I find the list of currently supported tags, and their usage? Or is this project dead?

[antograssiot]

@XedinUnknown check the wiki for the supported tags. https://github.com/ApiGen/ApiGen/wiki/supported-annotations

[XedinUnknown]

Cheers. I suggest you put some link on the website.