Format parameters in docs using <dl>
Gary Feldman - September 8, 2006 - 17:39
| Project: | API |
| Version: | 4.7.x-1.x-dev |
| Component: | Code |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | needs work |
Description
This patch formats the parameter section of the Doxygen documentation produced by API using <dl>. This makes it easier to read, as the parameter name stands out from the descriptions, instead of running into each other. While I was at it, I factored the parameter parsing code out of api_parse_php_file.
My one main question is whether the pattern to extract the parameter name is correct. I used \w, which seems to match the valid PHP name characters including things like è, but I'm not 100% positive about it.
| Attachment | Size |
|---|---|
| parser.inc.patch | 3.07 KB |

#1
Here's the style file patch (pretty trivial, and for that matter, optional).
#2
coding style needs work--check all the spacing. there's a commented line of code being added. it looks like the preg_match was changed--i'd want neil or jonbob to look that over before committing the new one.