PDA

View Full Version : Automatic documentation generation for MEL codes bases


lanedaughtry
05-12-2006, 10:16 PM
Hello All,


I'm ramping up a tech art team and with our impending explosion of the MEL code base I want to look into auto doc utilities for maintaining our source code documentation. Does any one here have any experience with this? Iím looking for open source projects that could be retasked towards MEL. Any suggestions would be helpful.

-L

Robert Bateman
05-13-2006, 01:47 PM
well, i use doxygen. Basically just uses the standard doxygen flags, ie :


/// \brief a brief description of the function
/// \param $argument_name - description of the argument
/// \return info about the return arg
/// \note some notes
/// \todo anything still todo...
proc string myFunction(int $argument_name);


You need to make sure that *.mel is included in the file filter, also setting it to "optimise output for C" can be useful (no OOP in mel...)

lanedaughtry
05-16-2006, 09:47 AM
Just found it and started experimenting with it tonight. Thanks for the reply though Robert.

-L

CGTalk Moderation
05-16-2006, 09:47 AM
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.