The rst public a version date back to November 2002, when I was a Visiting Scholar at the University of Waterloo, Canada. candidate at the Universit degli Studi di Genova, Italy. The PSAT project began in September 2001, while I was a Ph.D. NotePSAT is a Matlab toolbox for static and dynamic analysis and control of electric power systems.
MathWorks seems to be using their own internal system to author HTML documentation.PSATPower System Analysis Toolbox Quick Reference Manual for PSAT version 2.1.2, June 26, 2008 Best I could come up with is using reflection to obtain some metadata about functions and classes, although that solution is not perfect.
Other people use it to write blog posts (see the official blogs on the MATLAB Central which are creating this way), or even generate text files later processed by static site generators (like Jekyll and Octopress frameworks).Īs far as I know, there are no public tools available that inspect MATLAB code on a deeper level and analyze function parameters. Another example is publishing to MediaWiki markup (format used by Wikipedia). For example I've seen it used to render equations using MathJax instead of relying on the built-in solution. In fact the publish-based workflow is extendable, and you could use it in interesting ways by creating custom XSL template files to transform and render the parsed comments. Note that it doesn't matter how you generated the HTML docs (you could have used publish or even manually written HTML files). You could also make your custom docs searchable by building Lucene index files using builddocsearchdb function (which internally powers the search functionality in MATLAB custom docs). This is done by creating info.xml and demos.xml files, and organizing the documentation in a specific way. One aspect you didn't mention is integrating the generated documentation into the builtin Help viewer. Think of it as a simpler MATLAB-specific version of Markdown which used here on Stack Exchange sites to format posts. You write regular M-files with specially crafted comments (in fact the file could be all comments with no code), then you publish the file to obtain rendered HTML (it also supports other targets such as PDF, DOC, LaTeX, etc.). The publish function could be used to author documentation. I think you've researched this topic well (how to generate HTML documentation from MATLAB functions), now it's up to you to choose which method works best for you. Parse(p, x, fftSize, fftShift, analysisWindowHandle) ValidationFcn = (isa(x, 'function_handle')) ĪddRequired(p, 'analysisWindowHandle', validationFcn) Can the code itself be analyzed? Can I use the information provided to the Matlab Input Parser already? Please mention your personal preference in comments.ĪddRequired(p, 'x', = (isnumeric(x) & isscalar(x)) ĪddRequired(p, 'fftSize', validationFcn) ĪddRequired(p, 'fftShift', validationFcn) Question: What is the Mathworks way to generate Matlab HTML documentation. I heard of Matlab's publish() function, but I did never see it used in the aforementioned sense. Private AdvertisementPackage advertisementPackage Java: //! an object representation of the advertisement package sent by the beacon They do not analyze the code in the sense, Doxygen does it for i.e. All possibilities need me to mention i.e.