[Bf-committers] API comments (doxygen use?)

[Campbell Barton]

Hi, this mail is regarding some of Joshua's recent commits, but
thought it could go to the list,

Recently I noticed comments with a different kind of syntax committed to git,

/* typedef for channel rearranging function
 * < list: list that channels belong to
 * < island: island to be moved
 * > return[0]: whether operation was a success
 */


Instead of doxygen which would look more like...

/**
 * typedef for channel rearranging function
 * \param list: list that channels belong to
 * \param island: island to be moved
 * \return whether operation was a success
 */


Is this apart of some new documentation generator?

Currently our convention is to either use plain text, or doxygen
formatting if more structured formatting is desired.

As noted in our style guide:
http://wiki.blender.org/index.php/Dev:Doc/Code_Style#API_Docs


If there is some proposal to move to another system can this be made
first before introducing it into Blender's code?

-- 
- Campbell