Features
- Formatted comments for classes, members, and global functions.
- Cross-referencing.
- Beautiful rendering of LaTeX formulas (through Mathjax). See e.g. model.ox for an example.
Example
As an example, have a look at the documentation for PcLiRE, an Ox package for solving Linear Rational Expectations models written by Sophocles Mavroeidis and me quite a while ago (see his website if you're interested in downloading the Ox code). PcLiRE documentation.News
April 30, 2015
I have migrated OxDoc to GitHub. The source code can be found here. The latest release and any future releases will be available here. Downloads: Windows version and Linux/MacOS version.
This release mainly provides Ox 7 support.
With thanks to Chris Ferrall (Queen's University in Canada).
November 30, 2010
I have uploaded version 0.991alpha which contains some small bugfixes compared to version 0.99alpha. Downloads: Windows version and Linux/MacOS version.
The following issues have been resolved:
- Issues with the 'include' option in oxdoc.xml have been resolved.
- Issues with the multiple transpose operators on a single line have been partly resolved. See F.A.Q. for a workaround.
November 28, 2010
New website design (downloaded from www.oswd.org).
February 6, 2010
I have uploaded version 0.99alpha to the website. Downloads: Windows version and Linux/MacOS version. The new version includes:
- a small setup program (bin\setup.bat on Windows, bin/setup on Linux) to set up LaTeX support
- a graphical interface (bin\oxdocgui on Windows, bin/oxdocgui on Linux) to run oxdoc without using the terminal. It also generates batch files, bash scripts, and oxdoc.xml so that running oxdoc with the same options is easily automated.
January 11, 2010
After a long break, and with kind help and suggestions from Chris Ferrall from Queen's University, I have decided to update oxdoc. New features include:
- Updated support for recent additions to the Ox language syntax
- Documentation of variables declared as members in classes
- Include search paths
- Option to include icons for projects / classes / members (see examples)
- Support for MathML, so that LaTeX formulas can be rendered from within the browser and there is no need to generate external images for each formula.