Maxscript Documentation Generator

Become a member of the CGSociety

Connect, Share, and Learn with our Large Growing CG Art Community. It's Free!

THREAD CLOSED
 
Thread Tools Search this Thread Display Modes
  05 May 2013
Hi Laurent,

that works really nice. I've used the .exe with shelllauch. The generated html doesn't link to the source however, it links to itself.
Just out of curiosity, would it be difficult to adapt this to another notation of the docstrings? I've been using the scheme by Johan Boekhoven for quite a while now.
Quote: /*<FUNCTION>
Description:
Update the progressbar and display a message.
Arguments:
<int/float> theProgress: the progress we're at.
<int/float> theMax: the maximum value
<string> theMessage: the message to be displayed, if undefine, the message isn't altered
Return:
<string> the message
</FUNCTION>*/


Anyway, this is really great and will surely help improve my docs. thanks a bunch!
 
  05 May 2013
Eventually.

It could be as an option in the command line (it's the second lexical analysis that would change).

For now I'm focusing on the prospective translation bugs first (the 1st lexical analysis pass)
 
  05 May 2013
Originally Posted by grabjacket: The generated html doesn't link to the source however, it links to itself.


This work as an html link, it'll work if you place your source and its doc on an http server.
 
  05 May 2013
The little useless update of tonight, a muuuch better css style.

http://laurentchea.com/dev/MaxscriptDoc/output.html
 
  05 May 2013
This is great! Congrats.

What about having this integrated with something that listens for files/changes and rebuilds documentation?!
__________________
Artur Leao | Co-Founder / Project Manager
You can do it! VFX
Porto/Lisbon - Portugal
http://www.ycdivfx.com
 
  05 May 2013
Originally Posted by Kameleon: This is great! Congrats.

Thanks. Next version is almost ready.

Originally Posted by Kameleon: What about having this integrated with something that listens for files/changes and rebuilds documentation?!

Well, that's exactly why I've developed it as a simple command line tool, and not in something that would need an UI.

It's up to you now to call it from wherever you want : an mxs file, a dotnet c# application, another python tool, and why not from a daemon that would check periodically a directory and call a DOS .bat file.

maxscriptDoc is processing one file at a time with extremely simple arguments (input/output), I think it's a good idea to let the user handle the rest of the process. For now though.
 
  06 June 2013
Update available : 0.2

http://laurentchea.com/dev/MaxscriptDoc/output.html
http://laurentchea.com/dev/Maxscrip...riptDoc-0.2.zip

It should correctly handle subfunctions.
There's a verbose mode (-v) in case of bug report
It should process plugin definition correctly now (see fooBar in the previous link)
Added some reST like syntax for text style (see the source file in the previous link)
 
  06 June 2013
Thread automatically closed

This thread has been automatically closed as it remained inactive for 12 months. If you wish to continue the discussion, please create a new thread in the appropriate forum.
__________________
CGTalk Policy/Legalities
Note that as CGTalk Members, you agree to the terms and conditions of using this website.
 
Thread Closed share thread



Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off
CGSociety
Society of Digital Artists
www.cgsociety.org

Powered by vBulletin
Copyright 2000 - 2006,
Jelsoft Enterprises Ltd.
Minimize Ads
Forum Jump
Miscellaneous

All times are GMT. The time now is 09:03 PM.


Powered by vBulletin
Copyright ©2000 - 2017, Jelsoft Enterprises Ltd.