The phpDocumentor output looks more complete now, thanks.
All we can do is give the tool some hints with special tags, like @return etc.
This is what the listing says about the parameter $information for COM_createHTMLDocument:
PHP Formatted Code
defining variables to be used when creating the output string 'what' If 'none'
then no left blocks are returned, if 'menu' (default)
then right blocks are returned string 'pagetitle'
Optional content for
the page's <title> string '
breadcrumbs' Optional content for the page'
s breadcrumb string 'headercode'
Optional code to go into the page's <head> boolean '
rightblock' Whether or not to show blocks on right hand side default is no (-1) array '
custom' An array defining custom function to be used to format Rightblocks
I do have troubles to understand these hints. Though, updating my plugin(s) to follow the trends requires some understanding. Same goes for other functions like ADMIN_list. The lack of examples or links (like: see the wiki at ...) makes the update a daunting task which is easily postponed.
A wireframe could be used to show the structure of the display, possibly mentioning the id's or class of the div's generated. Well, for complex functions it would be very useful.
There's the Plugin API.
This API is a manifest for 'mandatory' plugin components. It's a description of the API that a plugin should expose to the portal.
When I read in the documentation 'the api' would it be the case that the wiki page 'plugin API' is referenced?