Ye' old general discussion board. Basically, for everything that isn't covered elsewhere. Come here to shoot the breeze, shoot your mouth off, or whatever suits your fancy. This forum is not for asking programming related questions.
So I've been adding phpdoc comments all over my code ready to give it a whirl with phpdocumentor. I've never used phpdocumentor and I'm starting to feel a bit like I wanna go an stick my head in an electric cheesegrater right now
Can someone very simply explain to me what I do on the linux command line to generate some documentation for my entire directory of code? Pwetty please
I tried just running `./phpdoc --help' but got this error:
A few questions, have you set up an phpDocumentor ini file for your project?
If not, I'ld try that first: look in the user subdirectory of your phpdocumentor install and copy the ini file. Look through it for the various directories, its not the easiest configuration file, but its not as bad as some either...
Then you run it with "./phodoc -c configname" normally from the phpdocumentor directory is easiest.
A few things to watch out for. If you're running phpdoc from the commandline, make sure that major version of the cli PHP is the same as the web PHP. I know many installations that forget to replace the CLI version with php5 when they install a web PHP5... this will cause all kinds of problems....
nielsene wrote:A few questions, have you set up an phpDocumentor ini file for your project?
If not, I'ld try that first: look in the user subdirectory of your phpdocumentor install and copy the ini file. Look through it for the various directories, its not the easiest configuration file, but its not as bad as some either...
Then you run it with "./phodoc -c configname" normally from the phpdocumentor directory is easiest.
A few things to watch out for. If you're running phpdoc from the commandline, make sure that major version of the cli PHP is the same as the web PHP. I know many installations that forget to replace the CLI version with php5 when they install a web PHP5... this will cause all kinds of problems....
Thanks for the reply
Do I just copy default.ini to a new file in user/ and then set it up as I wish?
OK moving on, my PHP major version is 5, and is straight from apt in ubuntu (I've never had PHP4 installed on this system).
I'll give it whirl and get back to you thanks
(Still confused why they assign a new value to $this )
I know their website discusses putting this file in your application tree and adding phpdocumentor to your path, etc and running it from your application directory, but that's never worked for me, and I get all kinds of wierd errors when i try. I keep meaning to figure out why, since then I could atleast also distribute the documentation configuration for other developers in a good way...
As to why they reassign this.... I'm not sure, its often considered bad practice to do so...
You might want to upgrade to the newest version 1.3.0rc6; I'm currently running rc3 and it doesn't show the funny this re-assignment. Most of the 1.3.0 release candidates have been cleaning up php5 issues and I seem to remember hearing that assigning to this doesn't work in php5 but did in 4.
nielsene wrote:yes I just copy the default.ini to <appname>.ini.
I know their website discusses putting this file in your application tree and adding phpdocumentor to your path, etc and running it from your application directory, but that's never worked for me, and I get all kinds of wierd errors when i try. I keep meaning to figure out why, since then I could atleast also distribute the documentation configuration for other developers in a good way...
As to why they reassign this.... I'm not sure, its often considered bad practice to do so...
You might want to upgrade to the newest version 1.3.0rc6; I'm currently running rc3 and it doesn't show the funny this re-assignment. Most of the 1.3.0 release candidates have been cleaning up php5 issues and I seem to remember hearing that assigning to this doesn't work in php5 but did in 4.
Ah yes, it doesn't work in 5 (Fatal error). I was using RC4 before this but it was full of charcters that show up as ^M on the end of the line which means it was probably uploaded to an FTP server with binary mode on. I couldn;t be bothered fixing it so I figured I'd just get the latest non-RC version.
I'll try RC6 And if it has the $this reassignment issue I'll just run it from my PHP4 testing ground on my VDS.
Yeah, I switched to using it last year. I'm rather happy, but I hope they fix the type hinting problem soon. (Type hints completely confuse the parser, even if you manually add the tags....)
learning to setup a custom landing/tutorial page, took a little bit more work because of their choice of DocBook, but its a nice flexible format too.
I still wish I could find a corresponding tool for annotating SQL schema complete with linkages between tables and list of db users with various permissions, etc....