Yet Another Documentation System

  Add it to your Download Basket!

 Add it to your Watch List!


Rate it!
send us
an update
The PHP License 
5.0/5 1
Nathan Adams
ROOT \ Documentation
YADS (Yet Another Documentation System) is a clone of the documentation system that PHP uses for its API. Since PHP doesn't have it in a nice package for everyone and their twin to download and install (at least none that I can see), I figured I will just recreate it.

This system is pretty easy to configure to your needs. And you can easily make another layout template as all the content is "drawn" from MySQL and put into Smarty...all you need to do is work with the smarty variables (and you can see the included code.tpl file for exactly how you should code your template).

Here are the functions that are in this YADS install!

 * echo
 * pritntf

Developer comments

I created it for use with IrrLib, my game library, but it can be used for almost any project. I felt the other documentation systems were inferior and all of them didn't display code similar to PHP's doc system AND allow for comments (which is ingenious, I always find what I am looking for in the PHP documentation). Everything is generated on the "fly" via PHP, MySQL and Smarty.

And although it doesn't "cache" the content, I'm sure that could be easily implmented. But for now, enjoy! Oh yeah, best part is that your program doesn't have to be C++ or PHP based it can be a number of other langauges; and one change of a mysql value is all it takes to change the syntax highlighting.

Last updated on October 23rd, 2008

#documentation system #PHP API #PHP documentation #documentation #PHP #API #information

Add your review!