[Esapi-php] attribution and phpdoc conventions, redux
jah at jahboite.co.uk
Tue Feb 9 18:08:09 EST 2010
On 18/11/2009 19:17, Boberski, Michael [USA] wrote:
> Going forward, please take the approach in terms of phpdoc tags,
> format of attributions, etc. as demonstrated in "src\Adapter.php" and
> "src\adapters\MyCompanyAdapter.php" (likely have to do an update to
> get these new files). The goal again is to get closer to the
> esapi4java docs.
I have a couple of questions about phpdocs.
The docs will be generated with doxygen, right? Is there a config file
I can use? I'm seeing some odd things with the config I've generated,
for example a class level doc block is being appended to the file level
doc block as part of the 'since' tag - I'd like to rule-out the
possibility of it being the config I'm using.
I assume that, like java, we want to inheritdoc for reference
implementations except where there's something implementation specific
to document. That is, we don't want to maintain duplicate comments in an
interface and its implementing class. Right?
Finally, there's a few @created tags kicking about, is this an important
field? If so, is there a preferred method of including a create date?
The @since tag contains the base version number (1.6) - perhaps add
another @since with the create date?
More information about the Esapi-php