fenics team mailing list archive

[Chris Richardson <chris@xxxxxxxxxxxxx>]

Anders Logg wrote:
> Chris Richardson pointed me to the PHP documentation which looks
> pretty good:
>
>   http://www.php.net/manual/en/function.explode.php
>
> Note the sections ChangeLog, Examples and Notes. Being able to add
> notes seems very useful.
>
> It is generated using DocBook:
>
>   http://doc.php.net/php/dochowto/docbook-whatis.php
>
> The problem with it seems to be it's a nightmare to write the input:
>
>   http://doc.php.net/php/dochowto/chapter-skeletons.php
>
> --
> Anders
>
>   
Docbook does have the advantage of being mature... if you look at an 
actual example, e.g.

http://svn.php.net/repository/phpdoc/en/trunk/language/types/array.xml

it does not seem too bad, just XML, (OK - you might think this is 
terrible)... and it would allow a certain amount
of auto-generation (e.g. function prototypes) from the code.

Chris