Generating Documentation

Overview

XMF provides a mechanism to export documentation for a name-space in HTML format. Given a name-space, for example XCore, the command:
will export a directory called XCore containing HTML documentation for the contents of the name-space XCore. You can use this facility to export documentation for your XMF projects. To see an example of exported documentation click here. Note that documentation is generated into a directory structure that expects to be rooted at Root. Therefore, the generated XCore directory should be placed into a Root directory so that link references are correct. In generate the name-space R with path Root::P::Q::R will generate a directory named R that should be placed in a directory Root/P/Q.