Automatic documentation generation for MEL codes bases

[Robert Bateman]

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]

Just found it and started experimenting with it tonight. Thanks for the reply though Robert.

-L

[CGTalk Moderation]

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.