WordPress self-documentation rendered using RDoc
Ruby
Switch branches/tags
Nothing to show
Pull request Compare This branch is 23 commits behind dxw:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
Doxyfile.erb
README.rdoc
doxydoc.rb
update_codex.rb

README.rdoc

WordPress API

WordPress self-documentation rendered using RDoc.

Generate your own

How to generate the documentation:

git clone git://github.com/dxw/wordpressapi.git
cd wordpressapi
gem install wpdoc
git clone git://github.com/dxw/geshi.git
git clone git://github.com/dxw/wordpress.git
ln -s wordpress/wp-includes
ruby update_codex.rb
ruby doxydoc.rb

And your documentation will be in doc.

How it works

We create an RDoc::Parser that uses Doxygen, and then we use some magick to convert that into RDoc's internal format.

Motivation

Why not just use Doxygen's HTML output? Or PhpDocumentor (which doesn't work)?

Because Doxygen's docs are neither pretty nor Ajaxy. With RDoc, we can use pretty generators like wpdoc ( github.com/dxw/sdoc/tree/wordpress ), our fork of the beautiful sdoc.