User forums > Using Code::Blocks

Help - Documentation Comment Block - Function & Use

(1/1)

Barking_Mad:
Hi guys, im new to CB and have noticed a feature that uses documentation comments:


--- Code: ---/**
  * This is a documentation comment block
  * @param xxx does this (this is the documentation keyword)
  * @authr some user (this is the documentation keyword error)
  */


--- End code ---

I was wondering where i could get more information on how this works, what the keywords are and how it may be of use over standard commenting. Anyone got any tips?

mariocup:
Hi Barking_Mad,

this is doxygen documentation style. Have a look at the doxygen docu.

Barking_Mad:
Thanks, will do.

Navigation

[0] Message Index