Re: Re: Auto-generated API documentation

On Tue, Jun 10, 2008 at 3:06 AM, Martin Jansen <martin@divbyzero.net> wrote: > Baptiste Autin wrote: >>> >>> --ignore */data/*,*/tests/* >> >> Thanks a lot Martin. >> >> Wouldn't that make sense to exclude /examples/* too? > > I'm not sure sure about this. Examples are a valuable resource when > figuring out how a package (without documentation in the manual probably) > works. Having the source code of the examples readily available in the API > documentation might be handy then. I agree - examples should be included in the auto-generated documentation.. and I would hesitate to remove any documentation that may be there already. But I can see the need for a developer to omit specific files within the API docs. I'm not sure if this is possible, but I recall some discussion in IRC about a feature for phpDocumentor which would omit the entire file @ignorefile. Anyone know the status of this? Chuck? -- Brett Bieber http://saltybeagle.com/