Tickets :: Comment on [#6131] API calls definitions automatically rendered as wiki pages

* Your Email Address
* Spam protection	Enter the letters below: .___. ..__ .___.. , \| \|[__) _/ \./ \| \__\|[__)./__. \|
Comment	> I added the Horde_Document classes as a Horde_Relection package to > the framework, including proper credits to Sergio Carvalho and a few > coding style tweaks. The Wiki driver should still be changed to not > mess with the method names. I see why this is necessary for the > (external) API documentation, but it doesn't help if this should > become a general purpose package. Instead, a subclass could hook into > the method name processing. > > > > I changed my mind and would like to see this script added to > wicked/scripts/. By default, it could be run in any Horde > installation to autogenerate API docs of the currently installed > Horde apps. > > > > I would like it to generate the following wiki page structure. The > prefix should be editable in the script header, so that we would > create everything below /Doc/Dev/Apis/, a sane default might be > /HordeApis/: > > > > Apis (or HordeApis) - contains the instructions how to call the api > methods. The RPC package has more example that have just been added > by Chuck. Additionally in contains a list to all application > sub-pages, e.g.: > > Apis/KronolithApi - contains a list of versions. The idea is to allow > to keep track of different application versions. Thus the script > should not rewrite this page completely, but only add new versions as > it detects them. > > Apis/KronolithApi/2.2-cvs - contains the actual API docs. This could > safely be overwritten. If run on a stable version, it won't change > anyway, and if run on a cvs version, it properly updates the docs. > >
Attachment
Watch this ticket

Saved Queries