Re: HTML_PAGE2 - PEAR PHPDoc API Convertor and questions

From: Date: Sat, 28 Oct 2006 08:07:49 +0000
Subject: Re: HTML_PAGE2 - PEAR PHPDoc API Convertor and questions
References: 1 2  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-44781@lists.php.net to get a copy of this message
Arnaud Limbourg wrote:
Hi, Ian Warner wrote:
Hi I want to test the API docs generated locally. So what converter does PEAR use on its website to generate API docs? So I can match ouput correctly. I can see - XML:DocBook/peardoc2:default But I think this is used only for user documentation? I also always get these: Warning on line 48 - package HTML_Page2 is already in category HTML, will now replace with category HTML I am following the coding style but just dont see what the issue is: This is the offending section I think: Lastly the API docs on HTML_Page2 are quite extensive - but I think most of this information should reside in User Documentation, the API docs should explain the API only, please take a look at the below and Critique that please.
    
End-user Documentation should be added peardoc indeed. There is a phpdocoumentor output method to generate peardoc skeleton.
Cheers Arnuad, yeah I got that I think - I wanted to replicate the API docs on my local so I can see what I type in the code will look the same on my local as on PEAR site. At the moment I have - output=HTML:frames:earthli
Arnaud.


« previous php.pear.dev (#44781) next »