theseer/phpdox

Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)

phpdox's Issues

{@link URL description} implementation

Is there any plan to implement the {@link URL description} tag?

Exception: TheSeer\phpDox\ClassBuilderException

I've got this exception during jenkins building php job on windows 7.
[exec] phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts
[exec]
[exec] [05.11.2012 - 13:14:26] Using config file 'E:\Web Development\Jenkins\workspace\coach\phpdox.xml'
[exec] [05.11.2012 - 13:14:26] Registered output engine 'html'
[exec] [05.11.2012 - 13:14:26] Registered output engine 'graph'
[exec] [05.11.2012 - 13:14:26] Registered output engine 'todo'
[exec] [05.11.2012 - 13:14:26] Registered output engine 'xslrunner'
[exec] [05.11.2012 - 13:14:26] Starting to process project 'name-of-project'
[exec] [05.11.2012 - 13:14:26] Starting collector
[exec]
[exec]
[exec]
[exec] Oups... phpDox encountered a problem and has terminated!
[exec] It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!
[exec]
[exec] Exception: TheSeer\phpDox\ClassBuilderException
[exec] Location: E:\Web Development\wamp\bin\php\php5.4.3\pear\TheSeer\phpDox\collector\ClassBuilder.php (Line 127)
[exec]
[exec] Processing DocBlock failed
[exec]
[exec] #0 E:\Web Development\wamp\bin\php\php5.4.3\pear\TheSeer\phpDox\collector\ClassBuilder.php(92): TheSeer\phpDox\ClassBuilder->processMethods()
[exec] #1 E:\Web Development\wamp\bin\php\php5.4.3\pear\TheSeer\phpDox\collector\Analyser.php(114): TheSeer\phpDox\ClassBuilder->process()
[exec] #2 E:\Web Development\wamp\bin\php\php5.4.3\pear\TheSeer\phpDox\collector\Analyser.php(85): TheSeer\phpDox\Analyser->handleClass()
[exec] #3 E:\Web Development\wamp\bin\php\php5.4.3\pear\TheSeer\phpDox\collector\Collector.php(89): TheSeer\phpDox\Analyser->processFile()
[exec] #4 E:\Web Development\wamp\bin\php\php5.4.3\pear\TheSeer\phpDox\Application.php(123): TheSeer\phpDox\Collector->run()
[exec] #5 E:\Web Development\wamp\bin\php\php5.4.3\pear\TheSeer\phpDox\CLI.php(124): TheSeer\phpDox\Application->runCollector()
[exec] #6 E:\Web Development\wamp\bin\php\php5.4.3\phpdox(62): TheSeer\phpDox\CLI->run()
[exec]
[exec]
[exec]
[exec] .f
[exec] Result: 1

My build phpdox target:
"

"

My phpdox.xml file:
"

"

Is it some bug or my missconfiguration of something?

gist suppor for @example tag

The example Tag could be used to link to a gist.
This way example code can get an update when the code changes.
The multiple files in gist allow complex examples.

Variables in XML files are not working

I've tried both calling phpdox alone or using ant.

In both cases the ${basedir} and other variables aren't getting substituted.

I've tried both with phpdox 0.4 distributed trough PEAR and by cloning this repo.

I'm running PHP 5.4 (from Zend Server).

File not found error on --generate

The xml file is still not generated) :

fmaz@FMaz-Zino:/mnt/nas/www/phpdox$ sudo ./phpdox.php tests/data/
[sudo] password for fmaz: 
phpdox %version% - Copyright (C) 2010 - 2011 by Arne Blankerts

.....

phpdox %version% - Copyright (C) 2010 - 2011 by Arne Blankerts

Error while processing request:
 - fDOMException: loading file './xml/tests/data/test4.php.xml' failed.

Details as follows:
[XML-STRING] [Line: 0 - Column: 0] Warning 1549: failed to load external entity "/mnt/nas/www/phpdox/xml/tests/data/test4.php.xml"

I've also notice that the first time I run the process (when the xml/ folder doesn't exist) the error will concern the test0.php.xml file. The next time, it will concern test4.php.xml.

Finally, here's the resulting content of the xml/ folder:

fmaz@FMaz-Zino:/mnt/nas/www/phpdox$ ls -la xml/
total 12
drwxrwxrwx 2 502 502    0 2011-03-25 23:01 .
drwxrwxrwx 7 502 502    0 2011-03-25 23:00 ..
-rwxrwxrwx 1 502 502 1180 2011-03-25 23:00 classes.xml
-rwxrwxrwx 1 502 502  307 2011-03-25 23:00 interfaces.xml
-rwxrwxrwx 1 502 502  370 2011-03-25 23:00 namespaces.xml

Note that now I can reproduce that behaviour at will.
Might be good to note that the uid/gid 502 are dummy. ( As my uid is 1000), but as the chmod is o+rw for all that drive, I didn't expect problem for accessing files, or at least, a human readable error ( Can't create test0.php.xml in xml/ , check folder permission )

I'll try to edit my fstab to have the uid:gid 1000:1000, and I'll come back with further information is anything is changed.

Class \TheSeer\Tools\DirectoryScanner does not exist

root@cadmium:/var/www/phpdox/phpdox# pear install theseer/DirectoryScanner
PHP Deprecated: Comments starting with '#' are deprecated in /etc/php5/cli/conf.d/imap.ini on line 1 in Unknown on line 0
PHP Deprecated: Comments starting with '#' are deprecated in /etc/php5/cli/conf.d/mcrypt.ini on line 1 in Unknown on line 0
theseer/DirectoryScanner is already installed and is the same as the released version 1.0.2
install failed

chrisd@cadmium:/var/www/phpdox/phpdox$ ./phpdox.php -x /var/www/phpdox/joomladocs/ -c /var/www/phpdox/joomladocs/ -d /var/www/joomla16/Joomla\ 1.6.1/libraries/joomla/ -g html
PHP Deprecated: Comments starting with '#' are deprecated in /etc/php5/cli/conf.d/imap.ini on line 1 in Unknown on line 0
PHP Deprecated: Comments starting with '#' are deprecated in /etc/php5/cli/conf.d/mcrypt.ini on line 1 in Unknown on line 0
phpdox %version% - Copyright (C) 2010 - 2011 by Arne Blankerts

[15.06.2011 - 20:42:36] Loading additional bootstrap file '/var/www/phpdox/phpdox/src/bootstrap/html.php'
Unexpected error while processing request:

• exception 'ReflectionException' with message 'Class \TheSeer\Tools\DirectoryScanner does not exist' in /var/www/phpdox/phpdox/src/factory.php:89
  Stack trace:
  #0 /var/www/phpdox/phpdox/src/factory.php(89): ReflectionClass->__construct('\TheSeer\Tools...')
  #1 /var/www/phpdox/phpdox/src/factory.php(77): TheSeer\phpDox\Factory->getGenericInstance('\TheSeer\Tools...', Array)
  #2 /var/www/phpdox/phpdox/src/factory.php(134): TheSeer\phpDox\Factory->getInstanceFor('DirectoryScanne...')
  #3 [internal function]: TheSeer\phpDox\Factory->getScanner('.php', false)
  #4 /var/www/phpdox/phpdox/src/factory.php(83): call_user_func_array(Array, Array)
  #5 /var/www/phpdox/phpdox/src/cli.php(158): TheSeer\phpDox\Factory->getInstanceFor('Scanner', '.php', false)
  #6 /var/www/phpdox/phpdox/src/cli.php(106): TheSeer\phpDox\CLI->getScanner('/var/www/phpdox...', Object(ezcConsoleInput))
  #7 /var/www/phpdox/phpdox/phpdox.php(58): TheSeer\phpDox\CLI->run()
  #8 {main}

Please file a bugreport for this!

chrisd@cadmium:/var/www/phpdox$ php --version
PHP Deprecated: Comments starting with '#' are deprecated in /etc/php5/cli/conf.d/imap.ini on line 1 in Unknown on line 0
PHP Deprecated: Comments starting with '#' are deprecated in /etc/php5/cli/conf.d/mcrypt.ini on line 1 in Unknown on line 0
PHP 5.3.2-1ubuntu4.9 with Suhosin-Patch (cli) (built: May 3 2011 00:43:34)
Copyright (c) 1997-2009 The PHP Group
Zend Engine v2.3.0, Copyright (c) 1998-2010 Zend Technologies
with Xdebug v2.0.5, Copyright (c) 2002-2008, by Derick Rethans

Any ideas on what I might be doing wrong?

Chris.

loading file '${phpDox.home}/templates/html/list.xsl' failed

Hi,

I've tried all kinds of configuration options. Either phpdox is not interpreting the ${any} vars or somethings completely wrong with my installation.

When I enter full paths for the config:

I get:

Exception: TheSeer\fDOM\fDOMException
Location: /Applications/MAMP/bin/php/php5.3.6/lib/php/TheSeer/fDOMDocument/fDOMDocument.php (Line 137)

loading file '${phpDox.home}/templates/html/list.xsl' failed.

Build file is under a /build folder just like recommended from http://jenkins-php.org/

Parameter types

L.S.,

Is it possible to show the parameter types in the generated documentation?

e.g.
/**
@param string $foo
**/
function foo( $foo ){...}

Now it shows
Method foo ( $foo )

But it doesnt show that $foo needs to be a string.

Kind Regards.

Windows vs paths vs escaping.

Using:
install ok: channel://pear.pdepend.org/PHP_Depend-1.0.4
install ok: channel://pear.phpunit.de/phpcpd-1.3.5
install ok: channel://pear.phpunit.de/phploc-1.6.4
install ok: channel://pear.netpirates.net/DirectoryScanner-1.1.0
install ok: channel://pear.netpirates.net/fDOMDocument-1.2.4
install ok: channel://pear.netpirates.net/fXSL-1.0.4
install ok: channel://pear.pdepend.org/staticReflection-1.0.0
install ok: channel://pear.php.net/Console_CommandLine-1.1.3
install ok: channel://pear.netpirates.net/phpDox-0.4.0
install ok: channel://pear.phpmd.org/PHP_PMD-1.3.3
install ok: channel://pear.phpunit.de/PHP_CodeBrowser-1.0.2
install ok: channel://pear.phpqatools.org/phpqatools-1.0.0

C:\Graphite>phpdox
phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts

[20.03.2012 - 10:40:22] Using config file 'C:\Graphite\phpdox.xml'
[20.03.2012 - 10:40:22] Registered output engine 'html'
[20.03.2012 - 10:40:22] Registered output engine 'graph'
[20.03.2012 - 10:40:22] Registered output engine 'todo'
[20.03.2012 - 10:40:22] Registered output engine 'xslrunner'
[20.03.2012 - 10:40:22] Starting to process project 'Graphite'
[20.03.2012 - 10:40:22] Starting collector

.................................................. [50]
..................................... [87]

[20.03.2012 - 10:42:07] Collector process completed
[20.03.2012 - 10:42:07] Starting generator

..

Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and pa
ste the stacktrace (if given) along!

Exception: TheSeer\fDOM\fDOMException
Location: C:\php\PEAR\TheSeer\fDOMDocument\fDOMDocument.php (Line 125)

loading file 'build/phpdox/raphite\Graphite\Description.php.xml' failed.

[XML-STRING] [Line: 0 - Column: 0] Warning 1549: failed to load external entity
"file:///C:/Graphite/build/phpdox/raphite/Graphite/Description.php.xml"
#0 C:\php\PEAR\TheSeer\phpDox\generator\Generator.php(153): TheSeer\phpDox\Gener

ator->processClass()
#1 C:\php\PEAR\TheSeer\phpDox\generator\Generator.php(129): TheSeer\phpDox\Gener

ator->processGlobalOnly()
#2 C:\php\PEAR\TheSeer\phpDox\Application.php(158): TheSeer\phpDox\Generator->ru

n()
#3 C:\php\PEAR\TheSeer\phpDox\CLI.php(128): TheSeer\phpDox\Application->runGener

ator()
#4 C:\php\phpdox(62): TheSeer\phpDox\CLI->run()

It looks as though the code is looking at a path containing "\G" and treating it as a special character. Recommendation: Investigate file:/// uris in the generated xml, or alternative methods to work cross platform / avoid escaping.

Constants values are not generated

I've a resources class that contains only constants and I've observed that the generated API documentation for it is wired. I've only the constant in the left column and the actual value doesn't present in the page body while there's constant title. I've attached a picture for that to show the generated page:

Uploaded with ImageShack.us

stat() failed

phpdox crashes with the following error message. Oddly enough the corresponding file "facebook.php" as well as the complete directory "facebook" have been removed from "trunk" some builds ago. The error is triggered with every build.

The file "./xml/trunk/facebook/php/facebook.php.xml" seems not to be there either.

 [exec] Oups... phpDox encountered a problem and has terminated!
 [exec] It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!
 [exec] 
 [exec] Exception: ErrorException
 [exec] Location: /usr/share/php/TheSeer/phpDox/generator/raw/rawbuilder/XSLRunner/Streamwrapper/PathMapper.php (Line 185)
 [exec] 
 [exec] stat(): stat failed for ./xml/trunk/facebook/php/facebook.php.xml
 [exec] 
 [exec] #0 /usr/share/php/TheSeer/phpDox/generator/raw/rawbuilder/XSLRunner/Streamwrapper/PathMapper.php(185): Arraystat()
 [exec] #1 url_stat(0): Array->()
 [exec] #2 /usr/share/php/TheSeer/phpDox/generator/raw/rawbuilder/XSLRunner/Callback/LoadDocument.php(30): DOMDocument->load()
 [exec] #3 __invoke(0): Array->()
 [exec] #4 /usr/share/php/TheSeer/phpDox/generator/raw/rawbuilder/XSLRunner/XSLRunnerBuilder.php(104): Arraycall_user_func_array()
 [exec] #5 XsltCallback(0): Array::()
 [exec] #6 /usr/share/php/TheSeer/phpDox/generator/raw/rawbuilder/XSLRunner/CallbackHandler.php(12): Arraycall_user_func_array()
 [exec] #7 Carica\Xsl\Runner\XsltCallback(1): ()
 [exec] #8 /usr/share/php/TheSeer/fXSL/fxsltprocessor.php(163): XSLTProcessor->transformToDoc()
 [exec] #9 /usr/share/php/TheSeer/phpDox/generator/raw/rawbuilder/XSLRunner/XSLRunnerBuilder.php(77): TheSeer\fXSL\fXSLTProcessor->transformToDoc()
 [exec] #10 /usr/share/php/TheSeer/phpDox/generator/raw/RawGenerator.php(56): TheSeer\phpDox\XSLRunnerBuilder->run()
 [exec] #11 /usr/share/php/TheSeer/phpDox/Application.php(181): TheSeer\phpDox\RawGenerator->run()
 [exec] #12 /usr/share/php/TheSeer/phpDox/CLI.php(127): TheSeer\phpDox\Application->runGenerator()
 [exec] #13 /usr/bin/phpdox(70): TheSeer\phpDox\CLI->run()
 [exec] 

TIA
Marcus

phpdox - encountered a problem and has terminated.

Running on mac osx lion

I've used pear to install phpdox.
First I got the error using the example code at https://github.com/thePHPcc/bankaccount/

(I have the bankaccount app running in Jenkins, and everything is building except phpdox, I'm new to this so hoping i'm
missing something simple)

so I did the following to break it down and get the same error.

phpdox -v
phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts

I ran the following command which worked fine, but when I try to use the phpdox.xml.dist file I get the error below:
phpdox --skel > phpdox.xml.dist

ERROR:

phpdox -f phpunit.xml.dist
PHP Fatal error: Call to a member function getAttribute() on a non-object in /usr/lib/php/pear/TheSeer/phpDox/config/GlobalConfig.php on line 73
PHP Stack trace:
PHP 1. {main}() /usr/bin/phpdox:0
PHP 2. TheSeer\phpDox\CLI->run() /usr/bin/phpdox:62
PHP 3. TheSeer\phpDox\GlobalConfig->isSilentMode() /usr/lib/php/pear/TheSeer/phpDox/CLI.php:100

Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!

Exception: ErrorException
Location: /usr/lib/php/pear/TheSeer/phpDox/config/GlobalConfig.php (Line 73)

Call to a member function getAttribute() on a non-object

ERROR i get in Jenkins when doing a build on the BankAccount

phpdox:
[exec] phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts
[exec]
[exec]
[exec]
[exec] Oups... phpDox encountered a problem and has terminated!
[exec] It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!
[exec]
[exec] Exception: ErrorException
[exec] Location: /usr/lib/php/pear/TheSeer/phpDox/logger/ShellProgressLogger.php (Line 63)
[exec]
[exec] 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() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'America/Chicago' for 'CDT/-5.0/DST' instead
[exec]
[exec] #0 /usr/lib/php/pear/TheSeer/phpDox/logger/ShellProgressLogger.php(63): Arraydate()
[exec] #1 /usr/lib/php/pear/TheSeer/phpDox/CLI.php(108): TheSeer\phpDox\ShellProgressLogger->log()
[exec] #2 /usr/bin/phpdox(62): TheSeer\phpDox\CLI->run()
[exec]
[exec]
[exec]
[exec] Result: 1

Error in first execution

00:30:29:~/htdocs/service (release/1.4)$ sudo pear install pear.netpirates.net/phpDox-0.4.0
downloading phpDox-0.4.0.tgz ...
Starting to download phpDox-0.4.0.tgz (55,733 bytes)
.............done: 55,733 bytes
downloading DirectoryScanner-1.1.0.tgz ...
Starting to download DirectoryScanner-1.1.0.tgz (3,644 bytes)
...done: 3,644 bytes
downloading fDOMDocument-1.2.4.tgz ...
Starting to download fDOMDocument-1.2.4.tgz (17,128 bytes)
...done: 17,128 bytes
downloading fXSL-1.0.4.tgz ...
Starting to download fXSL-1.0.4.tgz (5,798 bytes)
...done: 5,798 bytes
downloading staticReflection-1.0.0.tgz ...
Starting to download staticReflection-1.0.0.tgz (41,278 bytes)
...done: 41,278 bytes
install ok: channel://pear.netpirates.net/DirectoryScanner-1.1.0
install ok: channel://pear.netpirates.net/fDOMDocument-1.2.4
install ok: channel://pear.netpirates.net/fXSL-1.0.4
install ok: channel://pear.pdepend.org/staticReflection-1.0.0
install ok: channel://pear.netpirates.net/phpDox-0.4.0

00:35:57:~/htdocs/service (release/1.4)$ phpdox --skel > phpdox.xml.dist

00:36:17:~/htdocs/service (release/1.4)$ phpdox
phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts

[12.03.2012 - 00:36:18] Using config file '/home/jrbasso/htdocs/service/phpdox.xml.dist'
[12.03.2012 - 00:36:18] Registered output engine 'html'
[12.03.2012 - 00:36:18] Registered output engine 'graph'
[12.03.2012 - 00:36:18] Registered output engine 'todo'
[12.03.2012 - 00:36:18] Registered output engine 'xslrunner'
[12.03.2012 - 00:36:18] Starting to process project 'phpdox'
array(2) {
  [0]=>
  string(10) "${basedir}"
  [1]=>
  string(7) "basedir"
}
[12.03.2012 - 00:36:18] Starting collector



Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!

Exception: TheSeer\DirectoryScanner\Exception
Location: /usr/local/lib/php/TheSeer/DirectoryScanner/directoryscanner.php (Line 171)

Path '${basedir}/src' does not exist.

#0 /usr/local/lib/php/TheSeer/phpDox/Application.php(118): TheSeer\DirectoryScanner\DirectoryScanner->__invoke()
#1 /usr/local/lib/php/TheSeer/phpDox/CLI.php(124): TheSeer\phpDox\Application->runCollector()
#2 /usr/local/bin/phpdox(62): TheSeer\phpDox\CLI->run()

Error in Jenkins Job

Hello,

Do you know why this is happening?

Thanks

phpdox:
[exec] phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts
[exec]
[exec] [08.04.2012 - 14:29:47] Using config file '/Users/Shared/Jenkins/Home/jobs/jenkings-test/workspace/phpdox.xml.dist'
[exec] [08.04.2012 - 14:29:47] Registered output engine 'html'
[exec] [08.04.2012 - 14:29:47]
[exec]
[exec] Oups... phpDox encountered a problem and has terminated!
[exec] It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!
[exec]
[exec] Exception: ErrorException
[exec] Location: /Applications/MAMP/bin/php/php5.3.6/lib/php/TheSeer/phpDox/collector/Collector.php (Line 98)
[exec]
[exec] touch(): Utime failed: Operation not permitted
[exec]
[exec] #0 /Applications/MAMP/bin/php/php5.3.6/lib/php/TheSeer/phpDox/collector/Collector.php(98): Arraytouch()
[exec] #1 /Applications/MAMP/bin/php/php5.3.6/lib/php/TheSeer/phpDox/Application.php(123): TheSeer\phpDox\Collector->run()
[exec] #2 /Applications/MAMP/bin/php/php5.3.6/lib/php/TheSeer/phpDox/CLIRegistered output engine 'graph'
[exec] [08.04.2012 - 14:29:47] Registered output engine 'todo'
[exec] [08.04.2012 - 14:29:47] Registered outp.php(124): TheSeer\phpDox\Application->runCollector()
[exec] #3 /Applications/MAMP/bin/php/php5.3.6/bin/phpdox(62): TheSeer\phpDox\CLI-ut engine 'xslrunner'
[exec] [08.04.2012 - 14:29:47] Starting to process project 'jenkins-test'
[exec] [08.04.2012 - 14:29:47] Starting collec>run()
[exec]
[exec]
[exec]
[exec] tor
[exec]
[exec] f
[exec] Result: 1

Error while executing

My phpdox.xml.dist content:

<?xml version="1.0" encoding="utf-8" ?>

<phpdox xmlns="http://phpdox.de/config">
 <project name="Ubibanking" source="." workdir="build/phpdox">
  <collector publiconly="false">
   <include mask="*.php" />
   <exclude mask="lib/vendor/*,plugins/*,cache/*,build/*" />
  </collector>

  <generator output="build">
   <build engine="html" enabled="true" output="api"/>
  </generator>

When executing, I get the following output:

jenkins@beubiServer:~/jobs/UbibankingPrepareJenkins/workspace$ phpdox 
phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts

[20.02.2012 - 10:46:00] Using config file '/var/lib/jenkins/jobs/UbibankingPrepareJenkins/workspace/phpdox.xml.dist'
[20.02.2012 - 10:46:00] Registered output engine 'html'
[20.02.2012 - 10:46:00] Registered output engine 'graph'
[20.02.2012 - 10:46:00] Registered output engine 'todo'
[20.02.2012 - 10:46:00] Registered output engine 'xslrunner'
[20.02.2012 - 10:46:00] Starting to process project 'Ubibanking'
[20.02.2012 - 10:46:00] Starting collector

..................................................  [50]
..................................................  [100]
..................................................  [150]
..................................................  [200]
..................................................  [250]
..................................................  [300]
..................................................  [350]
..................................................  [400]
..................................................  [450]
..................................................  [500]
..................................................  [550]
..................................................  [600]
..................................................  [650]
..................................................  [700]
..................................................  [750]
..................................................  [800]
..................................................  [850]
..................................................  [900]
..................................................  [950]
..................................................  [1000]
..................................................  [1050]
..................................................  [1100]
..................................................  [1150]
..................................................  [1200]
..................................................  [1250]
..................................................  [1300]
..................................................  [1350]
..................................................  [1400]
..................................................  [1450]
..................................................  [1500]
..................................................  [1550]
..................................................  [1600]
..................................................  [1650]
..................................................  [1700]
..................................................  [1750]
..................................................  [1800]
..................................................  [1850]
..................................................  [1900]
..................................................  [1950]
..................................................  [2000]
..................................................  [2050]
..................................................  [2100]
..................................................  [2150]
..................................................  [2200]
..................................................  [2250]
..................................................  [2300]
..................................................  [2350]
..................................ff..............  [2400]
..................................................  [2450]
..................................................  [2500]
..................................................  [2550]
..................................................  [2600]
..................................................  [2650]
.........f

Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!

Exception: TheSeer\phpDox\ClassBuilderException
Location: /usr/share/php/TheSeer/phpDox/collector/ClassBuilder.php (Line 127)

Processing DocBlock failed

#0 /usr/share/php/TheSeer/phpDox/collector/ClassBuilder.php(92): TheSeer\phpDox\ClassBuilder->processMethods()
#1 /usr/share/php/TheSeer/phpDox/collector/Analyser.php(114): TheSeer\phpDox\ClassBuilder->process()
#2 /usr/share/php/TheSeer/phpDox/collector/Analyser.php(85): TheSeer\phpDox\Analyser->handleClass()
#3 /usr/share/php/TheSeer/phpDox/collector/Collector.php(89): TheSeer\phpDox\Analyser->processFile()
#4 /usr/share/php/TheSeer/phpDox/Application.php(123): TheSeer\phpDox\Collector->run()
#5 /usr/share/php/TheSeer/phpDox/CLI.php(124): TheSeer\phpDox\Application->runCollector()
#6 /usr/bin/phpdox(62): TheSeer\phpDox\CLI->run()

@property tag support

Please add Support for the "@Property" tag as documented at

http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.property.pkg.html

@todo as list

A list with all the comments in @todo because we do not like unfinished stuff in a release.

phpdox dies on generating on a huge codebase

Trying to document the OpenPSA codebase with the following command:

$ phpdox.php -x /tmp/foo  -c openpsa -g html

Fails in generation phase with:

Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!

Exception: TheSeer\fDOM\fDOMException
Location: /usr/share/php/TheSeer/fDOMDocument/fDOMDocument.php (Line 125)

loading file '/tmp/foo/openpsa/lib/midcom/helper/reflector/nameresolver.php.xml' failed.

[/tmp/foo/openpsa/lib/midcom/helper/reflector/nameresolver.php.xml] [Line: 33 - Column: 116] Fatal Error 9: Input is not proper UTF-8, indicate encoding !Bytes: 0xA0 0x40 0x72 0x65

#0 /home/bergie/Projects/tmp/phpdox/src/EventGenerator.php(260): TheSeer\phpDox\Generator->loadDataFile()
#1 /home/bergie/Projects/tmp/phpdox/src/EventGenerator.php(155): TheSeer\phpDox\Generator->processClass()
#2 /home/bergie/Projects/tmp/phpdox/src/EventGenerator.php(146): TheSeer\phpDox\Generator->processGlobalOnly()
#3 /home/bergie/Projects/tmp/phpdox/src/Application.php(181): TheSeer\phpDox\Generator->run()
#4 /home/bergie/Projects/tmp/phpdox/src/CLI.php(121): TheSeer\phpDox\Application->runGenerator()
#5 /home/bergie/Projects/tmp/phpdox/phpdox.php(58): TheSeer\phpDox\CLI->run()

Using today's PhpDox git version. The codebase I'm running this against is 130,629 lines.

global constant vs. class constant

An optional method parameter with a constant as default value (e.g. SORT_ASC) will result in

  <parameter name="sort" optional="true" byreference="false">
    <default>3</default>
  </parameter>

but if it is using a class constant like self::DETECT it will result in

  <parameter name="type" optional="true" byreference="false">
    <default>'__StaticReflectionConstantValue(self::DETECT)'</default>
  </parameter>

Is this the expected behavior?

Doesn't generate parameter/return documentation

I've a piece of code like this and the generated API documentation doesn't have documentation for each parameter or the return value. It only find documentation for the short and long function description.

/** \* Creates a new block blob or updates the content of an existing block blob. \* Updating an existing block blob overwrites any existing metadata on the blob. \* Partial updates are not supported with createBlockBlob the content of the \* existing blob is overwritten with the content of the new blob. To perform a \* partial update of the content of a block blob, use the createBlockList method. \* \* @param string $container name of the container \* @param string $blob name of the blob \* @param string $content content of the blob \* @param Models\CreateBlobOptions $options optional parameters \* \* @return none. \* \* @see http://msdn.microsoft.com/en-us/library/windowsazure/dd179451.aspx */ public function createBlockBlob($container, $blob, $content, $options = null) { throw new \Exception(Resources::NOT_IMPLEMENTED_MSG); }

forgot to push your submodule updates??

Hoi,
an online reference (http://progit.org/book/ch6-6.html) suggested to yell ;) , but I'd like to kindly ask :D
I found this while trying to fix the disaster I made previously. You can imagein that this becmoes a blocker for me ;)

Lapis

phpdox$ git submodule update
fatal: reference is not a tree: 0cca082a434ba0caa889bdd842aa168cc489607c
Unable to checkout '0cca082a434ba0caa889bdd842aa168cc489607c' in submodule path 'lib/staticReflection'

phpdox$ git log -1 lib/staticReflection
commit eb73b78
Author: Arne Blankerts [email protected]
Date: Mon Jul 4 23:17:59 2011 +0200

ref change for staticReflection

phpDox crash on execution

 [exec] .......f.........f....................
 [exec] 
 [exec] Oups... phpDox encountered a problem and has terminated!
 [exec] It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!
 [exec] 
 [exec] Exception: ReflectionException
 [exec] Location: /usr/share/php/pdepend/reflection/api/StaticReflectionProperty.php (Line 219)
 [exec] 
 [exec] Invalid property modifier given.
 [exec] 
 [exec] #0 /usr/share/php/pdepend/reflection/parser/Parser.php(1015): pdepend\reflection\api\StaticReflectionProperty->__construct()
 [exec] #1 /usr/share/php/pdepend/reflection/parser/Parser.php(980): pdepend\reflection\parser\Parser->_parsePropertyDeclaration()
 [exec] #2 /usr/share/php/pdepend/reflection/parser/Parser.php(795): pdepend\reflection\parser\Parser->_parsePropertyDeclarations()
 [exec] #3 /usr/share/php/pdepend/reflection/parser/Parser.php(450): pdepend\reflection\parser\Parser->_parseClassOrInterfaceScope()
 [exec] #4 /usr/share/php/pdepend/reflection/parser/Parser.php(255): pdepend\reflection\parser\Parser->_parseClassDeclaration()
 [exec] #5 /usr/share/php/pdepend/reflection/parser/Parser.php(192): pdepend\reflection\parser\Parser->_parse()
 [exec] #6 /usr/share/php/pdepend/reflection/parser/Parser.php(178): pdepend\reflection\parser\Parser->parseSource()
 [exec] #7 /usr/share/php/pdepend/reflection/queries/ReflectionQuery.php(114): pdepend\reflection\parser\Parser->parseFile()
 [exec] #8 /usr/share/php/pdepend/reflection/queries/ReflectionFileQuery.php(94): pdepend\reflection\queries\ReflectionQuery->parseFile()
 [exec] #9 /usr/share/php/TheSeer/phpDox/collector/Analyser.php(84): pdepend\reflection\queries\ReflectionFileQuery->find()
 [exec] #10 /usr/share/php/TheSeer/phpDox/collector/Collector.php(89): TheSeer\phpDox\Analyser->processFile()
 [exec] #11 /usr/share/php/TheSeer/phpDox/Application.php(123): TheSeer\phpDox\Collector->run()
 [exec] #12 /usr/share/php/TheSeer/phpDox/CLI.php(124): TheSeer\phpDox\Application->runCollector()
 [exec] #13 /usr/bin/phpdox(62): TheSeer\phpDox\CLI->run()
 [exec] 
 [exec] 
 [exec] 
 [exec] f
 [exec] Result: 1

I'm using phpDox 0.4.0 installed using PEAR

Fatal error on missing XSL extension

phpDox dies with a fatal error

Fatal error: Class 'XSLTProcessor' not found in /usr/local/php/pear/TheSeer/fXSL/fxsltprocessor.php on line 58

if PHP has no XSL extension. This should be replaced with a more graceful error message.

<code> not supported in generated HTML

Using PhpDoc code tags doesn't seem to be recognized by phpdox.

In generated HTML docs I see stuff like:

<code>// Loads the component for the first time $_MIDCOM->componentloader->load('fi.protie.navigation'); // Initializes the class $navigation = new fi_protie_navigation();// Display only nodes (folders)...</code>See the attributes of this class for additional customizing options.

Failed to load magic database at '/usr/share/misc/magic

I am using the phpdox.xml.dist found at http://jenkins-php.org/

Otherwise I am using this tutorial here http://edorian.posterous.com/setting-up-jenkins-for-php-projects

The jenkins project is taken from a github repo here: https://github.com/jcroll/MyDemo

I used the Pear installer to install phpdox. I had to invoke the version number in the installation because pear reported it's alpha software.

I'm using CentOS 5.7.

phpdox:
 [exec] phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts

 [exec] [23.05.2012 - 16:31:27] Using config file '/var/lib/jenkins/workspace/mydemo/phpdox.xml.dist'
 [exec] [23.05.2012 - 16:31:27] Registered output engine 'html'
 [exec] [23.05.2012 - 16:31:27] Registered output engine 'graph'
 [exec] [23.05.2012 - 16:31:27] Registered output engine 'todo'
 [exec] [23.05.2012 - 16:31:27] Registered output engine 'xslrunner'
 [exec] [23.05.2012 - 16:31:27] Starting to process project 'mydemo'
 [exec] [23.05.2012 - 16:31:27] Starting collector



 [exec] Oups... phpDox encountered a problem and has terminated!
 [exec] It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!

 [exec] Exception: ErrorException
 [exec] Location: /usr/local/lib/php/TheSeer/DirectoryScanner/phpfilter.php (Line 56)

 [exec] finfo::finfo(): Failed to load magic database at '/usr/share/misc/magic'.

 [exec] #0 /usr/local/lib/php/TheSeer/DirectoryScanner/phpfilter.php(56): finfo->finfo()
 [exec] #1 accept(0): Array->()
 [exec] #2 /usr/local/lib/php/TheSeer/phpDox/collector/Collector.php(82): FilterIterator->rewind()
 [exec] #3 /usr/local/lib/php/TheSeer/phpDox/Application.php(123): TheSeer\phpDox\Collector->run()
 [exec] #4 /usr/local/lib/php/TheSeer/phpDox/CLI.php(124): TheSeer\phpDox\Application->runCollector()
 [exec] #5 /usr/local/bin/phpdox(62): TheSeer\phpDox\CLI->run()

Edit: Here is the exact repo version at the time I reported this incident: https://github.com/jcroll/MyDemo/tree/db687ff6855edbd210e4d89fbb5ec1982640fe0f

How do I use the output from phpdox?

Hi there.

I can't seem to generate any HTML output, and can't figure out how to use the XML output that I get. :-) Any help?

phpDox error on Mac OSX Lion

phpdox:
     [exec] phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts
     [exec] 
     [exec] [29.03.2012 - 22:48:23] Using config file '/Users/marcobehnke/Sites/TextAdventureNextGEN/phpdox.xml'
     [exec] [29.03.2012 - 22:48:23] Registered output engine 'html'
     [exec] [29.03.2012 - 22:48:23] Registered output engine 'graph'
     [exec] [29.03.2012 - 22:48:23] Registered output engine 'todo'
     [exec] [29.03.2012 - 22:48:23] Registered output engine 'xslrunner'
     [exec] [29.03.2012 - 22:48:23] Starting to process project 'Textadventure-NextGen'
     [exec] [29.03.2012 - 22:48:23] Starting collector
     [exec] 
     [exec] ..................................................  [50]
     [exec] ........................................            [90]
     [exec] 
     [exec] 
     [exec] [29.03.2012 - 22:48:26] Collector process completed
     [exec] [29.03.2012 - 22:48:26] Starting generator
     [exec] 
     [exec] php(81911,0xac49d2c0) malloc: *** error for object 0x21ee65e: pointer being freed was not allocated
     [exec] *** set a breakpoint in malloc_error_break to debug
     [exec] Result: 139

Installation-Tutorial is outdated

Hi, if you follow the install howto in the readme.md, you get the followig error message:

root@striker:/home/leo/repos/git/payity/framework/htroot# pear install pear.netpirates.net/phpDox
Attempting to discover channel "pear.netpirates.net"...
downloading channel.xml ...
Starting to download channel.xml (827 bytes)
....done: 827 bytes
Auto-discovered channel "pear.netpirates.net", alias "theseer", adding to registry
Failed to download theseer/phpDox within preferred state "stable", latest release is version 0.4.0, stability "alpha", use "channel://pear.netpirates.net/phpDox-0.4.0" to install
install failed

You must use pear install pear.netpirates.net/phpDox-0.4.0
Greetings
Leo

touch() missing permission cause warning

Abstract:

Sometime when I run phpdox without sudo it, I'll receive 1 warning per file scanned:

Expected:

A human readable error explaining the situation instead of a debug error.

Actual result:

PHP Warning:  touch(): Utime failed: Operation not permitted in /var/www/phpdox/phpdox/src/processor.php on line 90
PHP Stack trace:
PHP   1. {main}() /var/www/phpdox/phpdox/phpdox.php:0
PHP   2. TheSeer\phpDox\CLI->run() /var/www/phpdox/phpdox/phpdox.php:69
PHP   3. TheSeer\phpDox\Processor->run() /var/www/phpdox/phpdox/src/cli.php:84
PHP   4. touch() /var/www/phpdox/phpdox/src/processor.php:90

ErrorException in Container.php

I'm getting an ErrorException when attempting to generate documentation with the current git master:

phpdox %development% - Copyright (C) 2010 - 2012 by Arne Blankerts

[06.08.2012 - 11:14:45] Using config file '/tmp/test/phpdox.xml'
[06.08.2012 - 11:14:45] Registered output engine 'html'
[06.08.2012 - 11:14:45] Registered output engine 'graph'
[06.08.2012 - 11:14:45] Registered output engine 'todo'
[06.08.2012 - 11:14:45] Starting to process project 'phpdox'
[06.08.2012 - 11:14:45] Starting collector





Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!

Exception: ErrorException
Location: /home/adam/trees/phpdox/src/shared/Container.php (Line 193)

Argument 3 passed to TheSeer\phpDox\Container::checkDir() must be an instance of TheSeer\fDOM\fDOMElement, null given, called in /home/adam/trees/phpdox/src/shared/Container.php on line 190 and defined

#0 /home/adam/trees/phpdox/src/shared/Container.php(190): TheSeer\phpDox\Container->checkDir()
#1 /home/adam/trees/phpdox/src/Application.php(114): TheSeer\phpDox\Container->cleanup()
#2 /home/adam/trees/phpdox/src/CLI.php(124): TheSeer\phpDox\Application->runCollector()
#3 /home/adam/trees/phpdox/phpdox.php(62): TheSeer\phpDox\CLI->run()

git bisect suggests that the offending commit is 3723022.

The XML file I'm using is:

<?xml version="1.0" encoding="utf-8" ?>
<phpdox xmlns="http://phpdox.de/config" silent="false">
    <bootstrap />

    <project name="phpdox" source="src" workdir="xml">
        <collector publiconly="false">
            <include mask="*.php" />
        </collector>

        <generator output="docs">
            <build engine="html" enabled="true" output="html" />
        </generator>
    </project>
</phpdox>

The error occurs with or without any PHP files in the src directory.

Follow up error to #29

This happens when running on the Symfony2 code:

Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and paste the stacktrace along!

Exception: TheSeer\fDOM\fDOMException
Location: /usr/local/php531/lib/php/TheSeer/fDOMDocument/fDOMDocument.php (Line 125)

loading file '/tmp/xml/lib/vendor/Symfony/Component/Console/Tester/ApplicationTester.php.xml' failed.
#0 /home/benny/code/php/wsnetbeans/phpdox/src/generator.php(242): TheSeer\phpDox\Generator->loadDataFile()
#1 /home/benny/code/php/wsnetbeans/phpdox/src/generator.php(169): TheSeer\phpDox\Generator->processClass()
#2 /home/benny/code/php/wsnetbeans/phpdox/src/generator.php(139): TheSeer\phpDox\Generator->processWithNamespace()
#3 /home/benny/code/php/wsnetbeans/phpdox/src/application.php(176): TheSeer\phpDox\Generator->run()
#4 /home/benny/code/php/wsnetbeans/phpdox/src/cli.php(118): TheSeer\phpDox\Application->runGenerator()
#5 /home/benny/code/php/wsnetbeans/phpdox/phpdox.php(58): TheSeer\phpDox\CLI->run()

unable to run current master

i tried to run the current master of phpdox but as soon as i put the -g html option to generate documentation, it fails with the following (there is only htmlbuilder.php in the htmbuilder folder):

PHP Fatal error: {closure}(): Failed opening required '/home/david/tmp/phpdox/src/builder/htmlbuilder/functions.php' (include_path='.:/usr/share/php') in /home/david/tmp/phpdox/src/autoload.php on line 56
PHP Stack trace:
PHP 1. {main}() /home/david/tmp/phpdox/phpdox.php:0
PHP 2. TheSeer\phpDox\CLI->run() /home/david/tmp/phpdox/phpdox.php:58
PHP 3. TheSeer\phpDox\Application->runGenerator() /home/david/tmp/phpdox/src/cli.php:121
PHP 4. TheSeer\phpDox\HtmlBuilder->setUp() /home/david/tmp/phpdox/src/application.php:178
PHP 5. TheSeer\phpDox\HtmlBuilder->getXSLTProcessor() /home/david/tmp/phpdox/src/builder/htmlbuilder/htmlbuilder.php:58
PHP 6. TheSeer\phpDox\Generator->getInstanceFor() /home/david/tmp/phpdox/src/builder/htmlbuilder/htmlbuilder.php:69
PHP 7. call_user_func_array() /home/david/tmp/phpdox/src/generator.php:197
PHP 8. TheSeer\phpDox\Factory->getInstanceFor() /home/david/tmp/phpdox/src/generator.php:0
PHP 9. TheSeer\phpDox\Factory->getGenericInstance() /home/david/tmp/phpdox/src/factory.php:87
PHP 10. ReflectionClass->__construct() /home/david/tmp/phpdox/src/factory.php:91
PHP 11. {closure}() /home/david/tmp/phpdox/src/autoload.php:0

i run 5.3.3-1ubuntu9.5 but it looks like the file is just missing.

phpdox creates empty content

I have a bigger php project but running phpdox leaves only a few css files and an index.xhtml file.

This is the phpdox output:

phpdox:
     [exec] phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts
     [exec] 
     [exec] [29.03.2012 - 20:08:23] Using config file '/var/lib/jenkins/jobs/Textadventure/workspace/phpdox.xml'
     [exec] [29.03.2012 - 20:08:23] Registered output engine 'html'
     [exec] [29.03.2012 - 20:08:23] Registered output engine 'graph'
     [exec] [29.03.2012 - 20:08:23] Registered output engine 'todo'
     [exec] [29.03.2012 - 20:08:23] Registered output engine 'xslrunner'
     [exec] [29.03.2012 - 20:08:23] Starting to process project 'Textadventure-NextGen'
     [exec] [29.03.2012 - 20:08:23] Starting collector
     [exec] 
     [exec] ..................................................  [50]
     [exec] ...................................                 [85]
     [exec] 
     [exec] 
     [exec] [29.03.2012 - 20:08:27] Collector process completed
     [exec] [29.03.2012 - 20:08:27] Starting generator
     [exec] 
     [exec] ......                                              [6]
     [exec] 
     [exec] 
     [exec] [29.03.2012 - 20:08:27] Triggering raw engines
     [exec] 
     [exec] [29.03.2012 - 20:08:27] Generator process completed
     [exec] [29.03.2012 - 20:08:27] Processing project 'Textadventure-NextGen' completed.
     [exec] 
     [exec] 
     [exec] Time: 4 seconds, Memory: 9.50Mb
     [exec] 

and this my xml file

<?xml version="1.0" encoding="UTF-8"?>
<phpdox xmlns="http://phpdox.de/config">

    <project name="Textadventure-NextGen" source="." workdir="build/phpdox">

        <collector publiconly="false">
            <include mask="*.php" />
            <exclude mask="**/protected/vendors/**" />
            <exclude mask="**/protected/tests/**" />
        </collector>

        <generator output="build">

            <build engine="html" enabled="true" output="api" />

            <build engine="todo" enabled="true" output="todo">
                <file name="todolist.txt" encoding="utf-8" />
            </build>

        </generator>

    </project>

</phpdox>

Bad characters encoding into xml

For example:

<method name="getCampaign" start="28" end="31" abstract="false" final="false" static="false" visibility="public">
  <docblock>
     <description compact="�ол��ае� ���лк� на кампани�."/>
     <return type="Campaign"/>
  </docblock>
</method>

Invalid encoding of value of the compactattribute.
The source in utf8 encoding.

Directory filter not working properly

When I try to generate a doc of our libraries, phpdox will scan to many files because the filter is not working correctly. We have a FILE.php.xml which get scanned, but our filter is ".php" and not ".php*":

XML Error while processing request:
fDOMException: loading file '../tmp/xml/teqlibs/3rd_party/jpgraph/jpgraph_windrose.php.xml' failed.

Details as follows:
[/tmp/xml/teqlibs/3rd_party/jpgraph/jpgraph_windrose.php.xml] [Line: 432 - Column: 21] Fatal Error 9: Input is not proper UTF-8, indicate encoding !Bytes: 0xB0 0x27 0x3C 0x2F
#0 /phpdox/src/generator.php(218): TheSeer\fDOM\fDOMDocument->load('../tmp/xml/teql...')
#1 /phpdox/src/generator.php(146): TheSeer\phpDox\Generator->processClass(Object(TheSeer\fDOM\fDOMElement))
#2 /phpdox/src/generator.php(137): TheSeer\phpDox\Generator->processGlobalOnly()
#3 /phpdox/src/application.php(169): TheSeer\phpDox\Generator->run(Object(TheSeer\phpDox\ShellProgressLogger))
#4 /phpdox/src/cli.php(103): TheSeer\phpDox\Application->runGenerator(Array, '/intproj/users/...', '../tmp/teqlibs_...', false)
#5 /phpdox/phpdox.php(56): TheSeer\phpDox\CLI->run()
#6 {main}

Please file a bugreport for this!

Sample Output

It would be nice to see a screenshot of the sample output generated by phpdox in the project description.

Allow .html instead of .xhtml suffix

A configuration option would be nice to get .html instead of .xhtml as the suffix for the generated files.

List only abstract and interface

Hi,
using standard config, phpdox create only docs for abstract class and interface but nothing for concrete class.
Installation done via pear
OS win7
PHP 5.4.3

Here is the output of phpdox commandline
phpdox 0.4.0 - Copyright (C) 2010 - 2012 by Arne Blankerts

[16.05.2012 - 11:12:34] Using config file 'C:\dev\www\social\phpdox.xml'
[16.05.2012 - 11:12:34] Registered output engine 'html'
[16.05.2012 - 11:12:34] Registered output engine 'graph'
[16.05.2012 - 11:12:34] Registered output engine 'todo'
[16.05.2012 - 11:12:34] Registered output engine 'xslrunner'
[16.05.2012 - 11:12:34] Starting to process project 'Social'
[16.05.2012 - 11:12:34] Starting collector

ccccccccccccccccc [17]

[16.05.2012 - 11:12:34] Collector process completed
[16.05.2012 - 11:12:34] Starting generator

.................................................. [50]
..................... [71]

[16.05.2012 - 11:12:34] Triggering raw engines

Generating output from phpDox xml
Aggregating data

......

Generating documentation index
Generating class index
Generating class files

...

Generating interface index
Generating interface files

..

[16.05.2012 - 11:12:35] Generator process completed
[16.05.2012 - 11:12:35] Processing project 'Social' completed.

Time: 1 second, Memory: 1.50Mb

staticReflection require fails

Ubuntu 10.04 LTS, followed the instructions for dependencies, but had a failure when executing:

$ bin/phpdox/phpdox.php --help
PHP Warning:  require(pdepend/reflection/Autoloader.php): failed to open stream: No such file or directory in /home/USERNAME/bin/phpdox/phpdox.php on line 49
PHP Fatal error:  require(): Failed opening required 'pdepend/reflection/Autoloader.php' (include_path='.:/usr/share/php:/usr/share/pear') in /home/USERNAME/bin/phpdox/phpdox.php on line 49

Fix: phpdox.php

require 'pdepend/reflection/Autoloader.php';

to

require __DIR__ . '/lib/staticReflection/src/main/php/pdepend/reflection/Autoloader.php';

support @tutorial annotation

It would be great if you could implement support for PHPDocumentor style tutorials. This allows for extended documentation of higher applications levels. Basically the @tutorial node is a reference to a docbook xml document which gets integrated into the generated documentation. I offer to help with the implementation if you tell me where to start.

Directory not empty

Expert that I am in experiencing all sort of bugs, here's a new one.

fmaz@FMaz-Zino:~/Bureau/phpdox$ rm -rf xml/
fmaz@FMaz-Zino:~/Bureau/phpdox$ ./phpdox.php tests/data/
phpdox %version% - Copyright (C) 2010 - 2011 by Arne Blankerts

.....

PHP Warning:  rmdir(./xml/tests/data/..): Directory not empty in /home/fmaz/Bureau/phpdox/src/application.php on line 192
PHP Stack trace:
PHP   1. {main}() /home/fmaz/Bureau/phpdox/phpdox.php:0
PHP   2. TheSeer\phpDox\CLI->run() /home/fmaz/Bureau/phpdox/phpdox.php:57
PHP   3. TheSeer\phpDox\Application->runCollector() /home/fmaz/Bureau/phpdox/src/cli.php:96
PHP   4. TheSeer\phpDox\Application->cleanup() /home/fmaz/Bureau/phpdox/src/application.php:94
PHP   5. rmdir() /home/fmaz/Bureau/phpdox/src/application.php:192
phpdox %version% - Copyright (C) 2010 - 2011 by Arne Blankerts

Error while processing request:
 - fDOMException: loading file './xml/tests/data/test2.php.xml' failed.

Details as follows:
[XML-STRING] [Line: 0 - Column: 0] Warning 1549: failed to load external entity "/home/fmaz/Bureau/phpdox/xml/tests/data/test2.php.xml"

This time it's a regular local EXT partition.
Ps.: "Bureau" mean "Desktop" in french.

Here's the directory listing after the error occured of the file created inside the default xml/ folder:

fmaz@FMaz-Zino:~/Bureau/phpdox$ ls -lRa xml
xml:
total 44
drwxr-xr-x 2 fmaz fmaz 4096 2011-03-27 11:13 .
drwxrwxrwx 7 fmaz fmaz 4096 2011-03-27 11:13 ..
-rw-r--r-- 1 fmaz fmaz 1210 2011-03-27 11:13 classes.xml
-rw-r--r-- 1 fmaz fmaz  312 2011-03-27 11:13 interfaces.xml
-rw-r--r-- 1 fmaz fmaz  380 2011-03-27 11:13 namespaces.xml

Hope that will help !

Version Requirement in Documentation

The Documentation says that PHP 5.3.2+ is needed - when installing, a version requirement of PHP 5.3.3+ is shown.

PEAR cannot discover site

PEAR cant open the channel on port 80 or 443. Failure in name resolution

Any ideas?

Call to undefined method: fDOMException::toggleFullMessage

[09.07.2011 - 20:57:15] Collector process completed
[09.07.2011 - 20:57:15] Registering backend 'htmlBuilderClass'
[09.07.2011 - 20:57:15] Starting generator

....
Fatal error: Call to undefined method TheSeer\fDOM\fDOMException::toggleFullMessage() in /home/benny/code/php/wsnetbeans/phpdox/src/cli.php on line 130

Call Stack:
0.0006 646160 1. {main}() /home/benny/code/php/wsnetbeans/phpdox/phpdox.php:0
0.0074 1124808 2. TheSeer\phpDox\CLI->run() /home/benny/code/php/wsnetbeans/phpdox/phpdox.php:58

Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and paste the stacktrace along!

Exception: ErrorException
Location: /home/benny/code/php/wsnetbeans/phpdox/src/cli.php (Line 130)

Call to undefined method TheSeer\fDOM\fDOMException::toggleFullMessage()

Exclude does nothing

When trying to add exclude paths it doesn't appear to have an affect on the output I've tried all different exclude masks I could think of, including altering the include mask to an exclude without effect - this document is definitely being included as I can break it by adding rubbish to it.

<phpdox xmlns="http://phpdox.de/config">
 <project name="Project X" source="src" workdir="build/phpdox">
  <collector publiconly="false">
   <include mask="*.php" />
   <exclude mask="**external**" />
  </collector>

  <generator output="build">
   <build engine="html" enabled="true" output="api"/>
  </generator>
 </project>
</phpdox>

Exception: ErrorException ShellProgressLogger.php (Line 63)

I am getting the following error on PHP 5.3 (Amazon Linux AMI)

Oups... phpDox encountered a problem and has terminated!
It most likely means you've found a bug, so please file a report for this and paste the stacktrace (if given) along!

Exception: ErrorException
Location: /usr/share/pear/TheSeer/phpDox/logger/ShellProgressLogger.php (Line 63)

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() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'UTC' for 'UTC/0.0/no DST' instead
#0 /usr/share/pear/TheSeer/phpDox/logger/ShellProgressLogger.php(63): Arraydate()
#1 /usr/share/pear/TheSeer/phpDox/CLI.php(108): TheSeer\phpDox\ShellProgressLogger->log()
#2 /usr/bin/phpdox(62): TheSeer\phpDox\CLI->run()

My configuration file is based on: http://jenkins-php.org/

Here it is:

@inheritdoc support

As per http://blog.liip.ch/archive/2011/07/26/phpdoc-compilers-and-inheritdoc.html the @inheritdoc annotation is missing.

Documentation for DocBlock supported tags

I am new to DocBlocks and I am trying to comment my code (rather religiously). I followed phpDoc and their documentation on how to write DocBlocks. However, I realized later that phpDoc is old (and sorta deprecated). I am on PHP 5.3+ and use namespaces/use statements a lot.

I would really appreciate if phpdox can help beginners like me to get introduced in DocBlock writing something one the lines of how/which tags to use (I am using VIP vim phpDoc plugin to insert DocBlocks).

I also see that some constructs like are not allowed/parsed by phpdox. I have followed phpDoc till now but would like to keep my knowledge/know how up to date.

One can think of starting with phpDoc's documentation about tags and add phpdox specific notes.

Thanks

Generate a PHAR

Please generate a PHAR for lazy people

sh: dot: command not found when phpDox is executed from an Ant script

Say I want to generate the class graph with the following configuration:

<build engine="graph" enabled="true" output="graph">
    <dot executable="/opt/local/bin/dot" render="true" format="png" />
</build>

On my Mac platform/Eclipse IDE, when I run phpdox from the command line, everything is fine:

$ phpdox --file config/phpdox.xml.dist

But when I run the same from an Ant script:

<target name="php-dox"
        description="phpDox is a documentation generator for PHP code"
        depends="init">
    <echo>Building project documentation</echo>
    <exec dir="${basedir}" executable="${phpdox.executable}">
        <arg line="--file ${conf.dir}/phpdox.xml.dist" />
    </exec>
</target>

I get the following error:

sh: dot: command not found