Re: Re: phpDocumentor - adding manual files

From: Date: Tue, 10 Feb 2004 04:38:01 +0000
Subject: Re: Re: phpDocumentor - adding manual files
References: 1 2 3  Groups: php.pear.general 
Request: Send a blank email to pear-general+get-10590@lists.php.net to get a copy of this message
Hi Eskil, There is no special format, it is simply treated as plain text. There are long-term plans to look for URLs and even linkable elements, but practical questions have not been worked out yet. Greg Eskil Kvalnes wrote:
Hey, I got ChangeLog, INSTALL and README down now, but what about other files, like TODO, BUGS etc? And are there any special formats I should have these files in? phpDocumentor tags and so on. ----- Original Message ----- From: "Greg Beaver" <greg@chiaraquartet.net> To: "Eskil Kvalnes" <eskil@lynweb.no> Cc: <pear-general@lists.php.net> Sent: Monday, February 09, 2004 5:13 PM Subject: [PEAR] Re: phpDocumentor - adding manual files
Hi, If these files are in the highest common directory, they will be automatically grabbed if you pass them in to be parsed. /path/to/project/somefile.php /path/to/project/subdir/anotherfile.php /path/to/project/README README will be grabbed if you use --directory=/path/to/project or --filename=/path/to/project/somefile.php,/path/to/project/README However, if you have any files in another path, like so: /path/to/project/somefile.php /path/to/project/subdir/anotherfile.php /path/to/project/README /another/path/file.php The README file would have to be in the / directory, which is the only directory that /another/path/file.php and the other files have in common. Regards, Greg Eskil Kvalnes wrote:
Hi, how can I add manual files to the left-hand menu when generating documentation using phpDocumentor? Like the phpDocumentor manual: ChangeLog FAQ INSTALL README Todo List Packages: phpDocumentor Converters Sincerely, Eskil Kvalnes
-- PEAR General Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php


« previous php.pear.general (#10590) next »