PDA

View Full Version : 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 (http://www.vinsoft.it/phpdig/phpxref)

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 (http://www.vinsoft.it/phpdig/phpdig-1.6.2-with-doc.tar.gz).
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. :)