At the exact moment I was reading this message I was grepping through the code. Your page was faster.
Thank you.
--- On Sun, 11/9/08, Andrew Garrett andrew@epstone.net wrote:
From: Andrew Garrett andrew@epstone.net Subject: [Wikitech-l] Fancy AJAX MediaWiki code reference To: "Wikimedia developers" wikitech-l@lists.wikimedia.org Date: Sunday, November 9, 2008, 6:17 AM Hi all,
Usually, for code documentation, we've either grepped the code for the method we wanted to look for, or used doxygen. I'm sure many of us have found doxygen a little too clunky, with too many clicks to find the required information.
For fun, I ran a perl script to parse our source code and pick out function data. Then I wrote a simple web-interface that searches for functions as you type, displaying a list of declaration lines, with a [show] link to show the full code of the function.
I thought this might be useful to some people who constantly grep through the code to find out the arguments to a function.
The site is available at: http://mwref.werdn.us
The source code for the Perl script, and the website, is available in the 'mwref' directory on my git repository. Patches are most welcome! http://gitweb.werdn.us/?p=scripts/.git;a=summary (web interface) git://werdn.us/scripts/ (git repository)
A database dump of the extracted function data is available to download (~1 MB) from my server: http://werdn.us/~andrew/mw_reference.sql.gz
Enjoy!
-- Andrew Garrett
Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l