Easier documentation with Doctor Max

Nov 19, 2013 at 6:03pm

Easier documentation with Doctor Max

Hi everybody,

I have recently created “Doctor Max”, a simple tool to try to make Max 6 documentation easier for third-party libraries. We have used it to document the new version of bach (which, by the way, will be out in a couple of days!), but actually it is a more general tool, and maybe some of you might need it for their own libraries/externals/abstractions. We thought that it was worth to be shared.

The working principle is extremely easy: all documentation is done in your code, in a Doxygen-like way. Once you’ve properly documented your methods, attributes, arguments, etc., you can launch Doctor Max and obtain all the XML documentation files.

If anybody need such tool, you can download it from this page (Mac only, sorry…):
http://www.danieleghisi.com/research

In the zip file, there’s also an example of how the code should be commented.

Should you use the app, don’t hesitate to contact me to report any bug or issue!

Daniele

#271782
Nov 20, 2013 at 9:58am

this stuff rocks!!! my word!!!

#271875

You must be logged in to reply to this topic.