Re: phpDocumentor tutorials/extended documentation implementation

Hi Alex, We're not hoping to force lazy programmers to become un-lazy :). No software solution can solve that problem. This feature would be for the few, the proud who have actually an interest in writing useful documentation and would like to also be able to reference the API reference so that end users can easily flip back and forth between the two formats. The php.net manual of functions contains TONS of information about each function, and I use it almost every day, so I disagree with your statement that api docs contain too much stuff for the end-user. The problem is not in the auto-generation, it is in the comments generated from the source. If the programmers do not include enough information, there is nothing that can be done by the auto-generation to improve that. I think we are talking about two different problems here: 1 - getting programmer to write useful docs (cannot be solved by automatic anything) 2 - taking useful docs and making them more useful (can be solved by phpDocumentor) Take care, Greg "Alexander Merz" <alexander.merz@t-online.de> wrote in message news:3DF779F7.1060000@php.net... > Greg Beaver wrote: > > > put tutorials in a special directory > > tutorials/packagename/[subpackagename/]. tutorials is a subdirectory of > > any directory parsed. > - file role="doc" in package.xml > - peardoc (intro-section is exaktly dedicated for this) > > The problem is not to make tutorials public, the problem is the force > programmers to write real docs. Tutorials and an API-Doc are a good > excuse for programmers not to write end user docs like peardoc want to > be. Tutorials are often superficially, the auto-generated API-Doc > contains to much stuff for the end user. > > You propose for a docbook-styled markup for tutorial was already > discussed months ago and gets no real feedback. > > > >