Documented code

alivin70 · 10-06-2003, 01:18 AM

Hi Guys,
I want to contribute to Phpdig and to do so I'm working on it with my collaborator JyGius.

We made a full documented version of Phpdig 1.6.2.
You can see the generated documentation on my website:
Phpdig documentation

The documentation is intented to make devoloper's life easier.
We added comments to almost all functions in the code and generated an Html output.
We used both PhpDocumentor and Phpxref to parse the code to obtain the Html, and finally we decided to use Phpxref for its very powerful cross-referencing output.

Because many of you made some modification to the code, I thing we have to integrate our modification right now, before source code become incompatible.

You can download a tar.gz file containing all the documented code and the perl script to generate new Html doc
Phpdig documented code, tar.gz 264 Kb.
I can't attach it to this post because exceeds 200Kb

Please, have a look at the link above, play with it and if you like the work we've done, integrate our code with your.

Charter · 10-06-2003, 03:34 PM

Hi. Thanks for the code. I'll be integrating most of what's been posted so far, except boolean and phrase searching may wait for another release, but I'll try to get it all in the next release.

10-06-2003, 01:18 AM	#1
alivin70 Orange Mole Join Date: Sep 2003 Posts: 40	Documented code Hi Guys, I want to contribute to Phpdig and to do so I'm working on it with my collaborator JyGius. We made a full documented version of Phpdig 1.6.2. You can see the generated documentation on my website: Phpdig documentation The documentation is intented to make devoloper's life easier. We added comments to almost all functions in the code and generated an Html output. We used both PhpDocumentor and Phpxref to parse the code to obtain the Html, and finally we decided to use Phpxref for its very powerful cross-referencing output. Because many of you made some modification to the code, I thing we have to integrate our modification right now, before source code become incompatible. You can download a tar.gz file containing all the documented code and the perl script to generate new Html doc Phpdig documented code, tar.gz 264 Kb. I can't attach it to this post because exceeds 200Kb Please, have a look at the link above, play with it and if you like the work we've done, integrate our code with your.

10-06-2003, 03:34 PM	#2
Charter Head Mole Join Date: May 2003 Posts: 2,539	Hi. Thanks for the code. I'll be integrating most of what's been posted so far, except boolean and phrase searching may wait for another release, but I'll try to get it all in the next release. __________________ Responses are offered on a voluntary if/as time is available basis, no guarantees. Double posting or bumping threads will not get your question answered any faster. No support via PM or email, responses not guaranteed. Thank you for your comprehension.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Sleep in the code	davids211082	How-to Forum	2	05-19-2005 12:22 AM
Site Map Code	Warmbells	How-to Forum	10	12-16-2004 01:42 AM
Php code in results	1001studio	How-to Forum	7	12-03-2004 10:42 PM
Affiliate code	JPSSAU	How-to Forum	1	06-19-2004 06:51 AM
Code Requests	Charter	Feedback & News	0	02-29-2004 12:45 AM