Author Topic: Auto generate Doxygen comments  (Read 1227 times)

chucky666

  • Junior Community Member
  • Posts: 4
  • Hero Points: 0
Auto generate Doxygen comments
« on: October 06, 2009, 09:15:14 am »
Automatic generation (and actualization) of function/member (doxygen compatible) C/C++ comments. Should parse code and fill in:
function parameters - distinguish input and output variables, prepending out (or something user defined) to variable name, even if they are in function parameters.
used global(or instance) variables (also distinguish which were used for read and write) and global or external functions (optional).
errors - in case of throws / (return enums?).
function name, remarks, todos, comments, notes and so on - keywords, programmer can append own text.
Would be nice if format of comments could be specified as serie of tags (ie like printf).
Also add/modify file header - one template for all files in project, specifying Name, email, license, os, version, last revision, desription, notes, and so on.

Main purpose of this is to ease commenting code - programmer just fill in descriptions and that is. Another use is for better readability of uncommented legacy code.

ronw

  • Community Member
  • Posts: 36
  • Hero Points: 0
Re: Auto generate Doxygen comments
« Reply #1 on: December 02, 2011, 05:40:40 pm »
Language pages for "Document Comment" mark-up.

In document comment blocks, SlickEdit recognizes the various docomenting keywords, for example, it recognizes \return and highlights it accordingly. It does not recognize \returns so does not hightlight it. However, \returns is a valid synonym for \return

Also, some tools, for example Doxygen, allow defining new "commands".

I have looked in the language options, but there is no Language Page for Documentation Comments.

Clark

  • SlickEdit Team Member
  • Senior Community Member
  • *
  • Posts: 4922
  • Hero Points: 402
Re: Auto generate Doxygen comments
« Reply #2 on: December 03, 2011, 02:49:41 am »
You can already modify the doxygen keywords but it's not obvious. Go to the color coding for any language. Then choose Doxygen from the lexer name combo box.