MaxscriptDoc

4 votes
Version: 
0.2
Date Updated: 
05/27/2013

MaxscriptDoc automatically generates the documentation of a maxscript file, according to the comments found in the source code.

It's kind of a mix between javadoc and python documentation.

The "docStrings" are all the multiline comments that start with /*** and finish with ***/

The only elements it's trying to comment are struct, function, plugin and rollouts.

A docstring is always associated with the previously found struct|function|rollout.

There can be (there must be !) a starting docString at the beginning of the file, which will describe the script.

Here's an example :

sample.ms.txt

output.html

Usage :

MaxscriptDoc.exe -i inputfile.ms -o outputfile.html

You can also run the python files, the sources are distributed in the package.

AttachmentSize
maxscriptdoc-0.2.zip2.22 MB

Comments

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.
br0t's picture

I gave it a try. I had issues

I gave it a try. I had issues with tabs in my maxscript file. MaxscriptDoc only likes spaces as it seems, so I had to convert them manually using Notepad++ and a plugin (http://sourceforge.net/projects/tabstospacesnpp/?source=dlp). Maybe you could include something similar, so I dont have to worry about tabs/spaces? And include a cmdline flag like -t for "tabsToSpaces" or something like that. Keep going, it's awesome!

Never get low & slow & out of ideas

MrPingouin's picture

New version : 0.2

- Some reST syntax like to stylish text (bold, italic, underline), and add images. See source file.
- Subfunctions are now identified
- Plugins are now identified

I also added a verbose mode (-v) in case of bug report. :)

MrPingouin's picture

Some updates

Ok, we're close to version 0.2.
I've added basic formatting, it kinda looks like reST style (not exactly the same though, for regexp complexity : **bold**, __underline__, ++italic++).

I've also added the "@module keyword", that will not be printed in the docString, but will add a future link in the "See also" section.

http://laurentchea.com/dev/MaxscriptDoc/output.html

br0t's picture

Cool stuff Laurent!

Cool stuff Laurent!

Never get low & slow & out of ideas

barigazy's picture

...

Fantastic work, man. I follow your thread on CGTalk.
I like new look, also you can use dark gray tone (like max default color scheme).
On this page (first image "Browse Menu Item...") shows two cool color examples.
Even link ("online JQuery theme roller...") below opens interesting site for mobile apps themes.
Just keep it up with good work!

barigazy

MrPingouin's picture

Including images is now

Including images is now possible.

I haven't released a new version though, I need to add some url quoting and stuff like that (using urllib to translate ' ' to '%20' for example).

I've decided to use the python docutils reST "image" directive.

image:: pathToImage

Check the sample page at : http://laurentchea.com/dev/MaxscriptDoc/output.html

Brand new css too, much more elegant than the first version.

barigazy's picture

...

I mean when describe some fn, struct or even control event, with the comment can be placed and images related to some part of UI (rollout button, checkbox ets.)
Something like this http://www.cgplusplus.com/online-reference/maxscript-reference/source/ro.... In the *.chm version of MaxScript Document you can click on any part of the image and then jump to specific topic related to this part (behaves as hyperlink.)
Sorry for my bad english :)

barigazy

MrPingouin's picture

Pictures thumbs ?

I don't get it, picture thumbs ?
Could you be more specific ? You mean allowing to add url to images for example ?

It is planned, using reST python library (kind of a wiki syntax). Not a top priority feature though, I'm focusing for now on the prospective translation bugs.

barigazy's picture

+1

Interesting solution. I saw your thread on CGTalk about this.
Adding picture thumbs will be also nice. Can you consider this maybe in the next update.
By the way thanks for sharing.
Cheers!

barigazy

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.