Doxygen support to show functions of a file
Roi Danton - October 28, 2008 - 12:47
| Project: | Advanced help |
| Version: | 6.x-1.x-dev |
| Component: | Code |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | won't fix |
Jump to:
Description
Omg, what an unrealistic request. ;)
By writing a documentation for a module providing an API for others it would be helpful if advanced help has Doxygen support like api.module or this site shows.
The advantage I see of having Doxygen support inside an Advanced Help (submodule) instead of another module is the integration with other document files. So e.g. the documentation writer includes a function as a token like &doxy:file/function& and the function, the description, the parameters and returns are shown in the doc (like at http://api.drupal.org).
Could this be a long term goal for advanced help or does a Doxygen support conflict with Advanced Help intentions?
#1
Well, doxygen isn't exactly what you want, I think. Doxygen does automatic parsing, and api.module is kind of a specialized implementation of doxygen. I don't think that's something api.module *can* do. Now, having something else that parses and produces advanced help files from that kind of output could be cool, but it's a large project and unfortunately somewhat out of scope.
#2
Closing this issue.