Plugins, WordPress

Getting phpDoc into WordPress

phpDoc to WordPress exports documentation generated by phpDocumentor into WordPress. Start using it today.

The best way to produce useful documentation for PHP code is to annotate it with phpDoc tags and keywords. Based on javadoc, phpDoc goes beyond a straightforward description of what something does, and allows the developer to add extra information which will help others who read the code to quickly understand its most important aspects. For example, a function can marked up to say when it was added to a project, its arguments types, and its return values.

From this phpDoc markup, the phpDocumentor app is the best way to generate standalone documentation that you can distribute with your project or make available as a reference on your website. But what happens when you want this documentation inside your WordPress?

Continue reading