Re: Documenting the Zend2 extension API

On 04/26/2007 09:47 PM, Marcus Boerger wrote:

Hello Antony, Thursday, April 26, 2007, 12:25:30 AM, you wrote:

On 04/26/2007 02:12 AM, Marcus Boerger wrote:

Doxygen (which seems to be uses by the majority of F/OSS projects) generates completely unreadable docs. Every time I look into ICU docs (generated by Doxygen) I get lost for 10 minutes trying to find a function _by name_. In the same time, other tools do not provide such a wide range of output formats as available in Doxygen.

Hu? It has a search option if you want.

This one? =) http://www.icu-project.org/apiref/icu4c/search.php?query=strcat

And it has alphabetical lists for functions, consts, classes, files, modules, whatever.

Maybe there is something wrong with ICU docs (or with me?), but I can't find any alphabetical index of functions. All I can see is a list of functions per file, which is noway convenient.

Go to: http://www.php.net/~helly/php/ext/spl/ On the left select 'file members' Then on the top of the main part select 'functions' That will give you all global functions.

You really think this is good structure?

Now, open 'Class Members' on the left Then on the top of the main part select 'functions' That will give you a list of all functions, each with a list of classes/interfaces implementing them

4 clicks just to get to the list of functions? No, doxygen is definitely not what I would like to use.

And if that is not enough we could take it's xml output to feed a database and provide a fulltext search on that.

We can also use any of search engines available to search in the result HTML. But the point is that the docs should be well structured enough so that a fulltext search would not be required.

As i said, from doxygen' XML output we can generate any kind of structure we see fit.

-- Wbr, Antony Dovgal