How to document object-oriented MATLAB code?

Posted by jjkparker on Stack Overflow See other posts from Stack Overflow or by jjkparker
Published on 2010-03-10T14:23:32Z Indexed on 2010/03/27 2:33 UTC
Read the original article Hit count: 307

Filed under:

matlab

|

documentation

|

best-practices

I'm writing a sizable application using object-oriented MATLAB, and this has gotten me thinking about how to document the code. If this was C, I would use Doxygen. For Java, I'd use JavaDoc. Both have mostly agreed-upon standards for how class and method documentation should look and what it should contain.

But what about MATLAB code? The most I've seen in TMW's own classes is a short sentence or two at the top of the class, and I can't find any topics devoted to documenting sizable MATLAB applications.

So how do you document your MATLAB classes? Any particular style issues or additional tools?

© Stack Overflow or respective owner

Related posts about matlab

Importing matlab functions in matlab

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I have some Matlab functions defined in .m files and I'd like to import them into Matlab (as in I'd like them to form part of the commands). Is this possible please and how can I do this? Thank you very much and regards, Krt_Malta >>> More
c# with matlab dll should be running on pc without matlab

as seen on Stack Overflow - Search for 'Stack Overflow'
hi, i have a very big problem. ich wrote a programm which is using a matlab dll. i build some classes with the matlab .net builder. it runs on my pc :) the problem is, i want to use ist on a pc without matlab. so i installed mcr, but it dont run :( what are the steps i should do? the system variable… >>> More
Matlab and .NET Interaction

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi All! I'm having an issue interacting between Matlab and .NET. I've managed to call .NET methods from Matlab code and vice versa. However, if I call a .NET method that, in turn, instantiates a Matlab object, it crashes (with a type initialization exception). Think about this scenario: a .NET… >>> More
Matlab matrix replacement assignment gives error

as seen on Stack Overflow - Search for 'Stack Overflow'
Hello, when i tried to update some part of a matrix, i got the following error message: ??? Assignment has fewer non-singleton rhs dimensions than non-singleton subscripts My code tries to update some values of a matrix that represent a binary image. My code is as follows: outImage(3:5,2:4,1) =… >>> More
MATLAB matrix replacement assignment gives error

as seen on Stack Overflow - Search for 'Stack Overflow'
I tried to update some part of a matrix, I got the following error message: ??? Assignment has fewer non-singleton rhs dimensions than non-singleton subscripts My code tries to update some values of a matrix that represent a binary image. My code is as follows: outImage(3:5,2:4,1) = max(imBinary(3:5… >>> More

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

as seen on SQL Authority - Search for 'SQL Authority'
I recently presented session on Statistics and Best Practices in Virtual Tech Days on Nov 22, 2010. The sessions was very popular and I got many questions right after the sessions. The number question I had received was where everybody can get the further information. I am very much happy that my… >>> More