Re: Re[2]: [PEAR-CVS] cvs: pear /PHPDoc phpdoc

Hayk Chamyan wrote: > Questions: > 1. In PHPDoc terms - module is a file containing functions and > constants. Can it contain variables? How do I need to document the > following code? > > <? > $corban_counter = 0; > > function corban_dear () > { > global $corban_counter; > > ... > > $corban_counter++; > > ... > } > ?> > Unfortunately, now the module parser does not parse the variable > documentation. For this purpose I could add variable parsing. Please > comment. Yes, I think we should do so. > 2. PHPDoc returns a warning like '[function] fetch_result mismatch' - > '1st parameter type "$format" does not match the the documented type > "integer"...' for the following code: I liked the idea of warnings, although they might be wrong in some cases. > 1. Maybe I should add some doc formatting meta-language (like BBCode or > Doxygen) for a better doc formatting to be also used by other renderers? Let's allow some, few XML (HTML) tags, if they're well-formed. Which ones do you think should be added? I don't want that many, people should not start with ASCII arts ... Which one ever we use it must be compatible to DocBook. > 2. Maybe I should write a renderer for rendering documentation in other > formats (PDF for example)? I'd not do this for the current version any more. Let's switch to DocBook and use existing DocBook tools. Ulf