peardoc2 update

From: Date: Wed, 11 Dec 2002 18:26:50 +0000
Subject: peardoc2 update
References: 1 2 3  Groups: php.pear.dev php.pear.doc 
Request: Send a blank email to pear-dev+get-11561@lists.php.net to get a copy of this message
Hi, In the cvs version of phpDocumentor (get a snapshot from http://developer.phpdoc.org/downloads), there is a fully functional DocBook converter (-o XML:DocBook:peardoc2 is the commandline). It is most likely imperfect, as I haven't yet had time to download jade and set up all the necessary stuff. It generates output that is identical to the sample peardocs I looked at from cvs.php.net. I plan to add in a few other features, such as the ability to not generate docs for files that only contain classes. What this would mean is that the classes WOULD have generated documentation, but no output to the otherwise empty procedural file would be generated. This is very difficult to describe, just take my word that it will be useful. In addition, I plan to add a feature whereby API docs can be generated for any PEAR package individually without having to parse the whole tree at once. To do this, it would assume that every {@link}/@see that referenced something not found is a valid link to a class or method (so, for example @see PEAR#PEAR would make a link to the class PEAR in package PEAR). Of course, the full @see would be required (package#class or package#class::$var or package#class::method()). That's about it. Take care, Greg "Arnaud Limbourg" <arnaud.limbourg@club-internet.fr> wrote in message news:20021211075748.17b77626.arnaud.limbourg@club-internet.fr... > Well, the URI makes more sense, people (at least developpers) are used to it. I'll read in detail the first email and come up with opinions if I have any ;) > > I like the idea of this tutorial thingie. > > BTW, any news from the phpdoc to peardoc2 front ? > > > After a few suggestions, I'm thinking the best way to do @tutorial is more > > like a URI: > > > > @tutorial package/subpackage/tutorial.ext#section.subsection > > > > Any opinions? > > > > Greg

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