Hi all, I'm trying to run PHPDocumentor on my WAMPServer setup. It runs fine, but I'd like to exclude certain directories, such as \sqlbuddy\ which don't contain my own code. Ironically, PHPDocumentor appears to be ignoring my --ignore switch. I've tried several ways of expressing the same thing, but with the same result. Below is the c...
Hi there. I'm basically new to PEAR (and PhpDocumentor); I installed PhpDocumentor using the PEAR CLI, and everything seemed to go fine... until I went to use it, at which point I got the following error: Warning: require(PhpDocumentor/phpDocumentor/phpdoc.inc): failed to open stream: No such file or directory in /usr/local/bin/phpdo...
Is there anything similar to netbean's Javadoc auto comment tool for PHP/phpDocumentor/Eclipse? In the netbeans implementation: A dialog pops up and allows you to run through all the members of your class and enter comments, which are added to the source file. It even verifies that there are no parameters you have not accou...
I'm trying everything I can to get phpdocumentor to allow me to use the DocBook tutorial format to supplement the documentation it creates: I am using Eclipse I've installed phpDocumentor via PEAR on an OSX machine I can run and auto generate code from my php classes It won't format Tutorials - I can't find a solution I've tried movi...
Hi, is there a possibility to include images into a docbook manual compiled by phpDocumentor? I tried both: <mediaobject> <imageobject> <imagedata fileref="payment_flowchart.png" format="png"/> </imageobject> </mediaobject> and: <figure><title>foo</title> <graphic fileref="payment_flowchart.png"/> </figure> Then again the i...
I want to use phpDocumentor classes for parsing of my own PHP documentation and working with results. I can do this manually, but I'm pretty sure that phpDocumentor could be used. The problem is that I can't find any documentation about this. How exactly should I use phpDocumentor's classes? Thanks for the link! ...
What is the X? Thanks ...
I have objects with many variables that I declare and explain in the comments. I am commenting very thoroughly for later processing using phpDoc, however I have no experience with actually compiling the documentation yet. I find it very annoying that with phpDoc notation, each variable eats up four to six lines of code even if the only ...
I've been playing with phpDocumentor recently and found it quite suitable for my needs. I'm largely working with PHP/HTML/JS/CSS codebases and would like phpDocumentor to parse my Javascript (and perhaps CSS) in order to keep it all together. I've managed to get phpdoc to parse javascript files contained throughout the codebase - howeve...
I'm having some issues getting phpdoc to run correctly. The docs are being generated for the most part successfully, but I get the following warning many times: Warning: date(): It is not safe to rely on the system's timezone settings. You are required to use the date.timezone setting or the date_default_timezone_set() funct...
First day I use phpDocumentor and so far so good, but I have a question that I didn't catch in the manual... The documentation of global variables. How would I document this code if: $someGlobalVar is not decalren in the PHP file of the class (it can even be undelared). $someGlobalVar is declared like this: $someGlobalVar = array(); (...
How must we document (with phpDocumentor) constants defined with define() in PHP? I found nothing in the docs, but found the following example (which I don't see it's use) in the sample2.php: /**#@+ * Constants */ /** * first constant */ define('testing', 6); /** * second constant */ define('anotherconstant', strlen('hello')); ...
Take in consideration the following PHP 5 class: class SomeClass { //I want to document this property... private $foo; function __construct() { } public function SetFoo($value) { $this->foo = $value; } public function GetFoo() { return $this->foo; } } How in phpDocumento...
As you know the NetBeans IDE will pop you inline documentation in your PHP sources based on the phpDocumentor syntax. What I found out is that when I use special HTML characters in my phpDocumentor documentation they are treated as HTML in NetBeans but as text in the HTMl doc generated by phpDocumentor. For example: /** * Add a new &...
Hi , I would like to fill the comment tag @version with Subclipse or Subversion in Eclipse. CVS has done this automatically but Subversion isn't. This would be very helpful. I tried to google "@version" but it seems impossible. Example what CVS did: <?php /* * @author Spankmaster * @version $Id: file.php,v 1.47 2009-09-21 09:28:4...
I find the one available at the website to be very overwhelming for a newbie at this. Is there a better tutorial out there, one that takes it a little slower, instead of throwing 3 long php source files at you? Edit: Is there really nothing else besides the manual??? D: ...
All the files in the code base I am documenting will always use the same version "string" Is there a way I can specific in a single place for the PhpDocumentor to use the same version for all files, regardless if it is specified or not (should auto-inherit) ...and what other tags would this be useful for off the top of your head? Edit:...
I have a PHP class with a method. In the base class (it's more like a prototype, but I'm not using prototypes because we have to be backwards compatible), I document the parameters and description of the method. Now I extend that class. In this new method (the implementation) should I re-document the parameters and description, should I...
Hey Guys, i hope someone can help me out on this one here. I use several associative arrays in my php application and i'm using php documentor to comment my sources. I never really did specified comments for the arrays in an array, but now i need to do that and dont know how. $array = array('id' => 'test', 'class' => 'tester', 'options'...
Okay, I'm fed up with phpDocumentator. It consumes way much more memory (1.4 GB) and time (5 minutes on 2.6GHz Core 2 Duo) than I'm willing to give it. Does there exist some really compatible program to generate documentation for PHP code? I've tried PHPDoctor, which looks nice, but it has some missing features. However it is probably c...