Extracting documentation using phpDocumentor? :: Zikula Community

Extracting documentation using phpDocumentor?

Posted: 15.08.2006, 22:06

rank:

Freshman

registered:

March 2006

Status:

offline

last visit:

18.08.06

Posts:

14

Hi -

I've been documenting a set of API compliant PN modules in the phpDocumentor style as I've developed them, but the generated documentation doesn't look too good because of the way arguments are passed to functions in PostNuke as one associative array.

Basicly I have something like:

Code
/**
* @param string A long string
* @param array An array
* @return array
*/
function MyModule_user_func($args) {
// ...
}

And the generated documentation looks like:

Code
array MyModule_user_func(string $args, array 1)

* array 1: An array
* string $args: A long string

I think the wrong arguments order and naming is quite misleading - did anyone experience this problem, and maybe even fixed/hacked it?

Thanks in advance!

Best regards, Jonas Delfs

edited by: jonasdelfs, Aug 15, 2006 - 05:07 PM
- notify mod
Posted: 15.08.2006, 22:14

rank:

Moderator

registered:

March 2002

Status:

online

Posts:

7720

The way we do it with the core code is as follows - using an example from the admin module

Code
/**
* create an admin category
*
* @author Mark West
* @param string $args['catname'] name of the category
* @param string $args['description'] description of the category
* @return mixed admin category ID on success, false on failure
*/

-Mark
- notify mod

Users online:

This list is based on the users active over the last 60 minutes.

Dizkus