Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
BuddyPress self-documentation rendered using RDoc
Branch: master
Pull request Compare This branch is even with stas:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.gitignore
Doxyfile.erb
README.rdoc
doxydoc.rb
update_codex.rb

README.rdoc

BuddyPress API

BuddyPress self-documentation rendered using RDoc.

Generate your own

How to generate the documentation:

Required gems:
* json
* nokogiri
* rdoc
* rdoc-data
* wpdoc

git clone git://github.com/stas/buddypressapi.git bpapi
svn co http://svn.buddypress.org/trunk/ buddypress
svn co https://geshi.svn.sourceforge.net/svnroot/geshi/trunk/geshi-1.0.X/src/ geshi
cd bpapi
ln -s ../buddypress buddypress
rm -rf buddypress/bp-forums/bbpress buddypress/bp-themes
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.

Fork of github.com/dxw/wordpressapi

Something went wrong with that request. Please try again.