RE: [Phpgroupware-developers] adodb/mssql

[Kai Hofmann]

> >   Use something like:
> >   php.exe phpdoc -t E:\Dokumente\phpgw\phpdoc_head 
> >                  -ti "phpGroupWare head API" 
> >                  -o HTML:frames:default 
> >                  -i 
> E:\Dokumente\phpgw\phpgw_head_api\phpgwapi\inc\adodb\* 
> >                   -d E:\Dokumente\phpgw\phpgw_head_api\phpgwapi\inc
> >   to generate the phpgw docs without adodb stuff creating errors.
> 
> Wouldn't it be better to create a 'phpdoc-ignore.csv' file in phpgwapi
> then it can be easily maintained and devs who use GNU enabled
> environments can run

phpdocumentor does not support an ignore file in version 1.3.x
(maybe in 2.x) - so this will not help.
But a good structure of the API would be to separate all things that
will be included from external sources into a different
directory like "ext" instead of adding these things to "inc".
This will also allow to ignore only one directory which includes all
external things.
Also this will make maintainance of the whole api more easier,
because every beginner can simply understand that he/she should
not touch the "ext" directory - which also should inclue a README
"don't touch this!".

> btw I removed "-o HTML:frames:default" as that is the default 
> setting and -ti to me just seems a waste

You can do what you want ... but I have a more generic batch script here
that also creates PDF documentation - for this one the ti is required.
What I posted was only an example nothing more nothing less.

> I would also like to see the docs integrate visually with the 
> rest of the website.

Feel free to create a template set for phpdocumentor.



PowerStat