Code::Blocks Forums

User forums => Using Code::Blocks => Topic started by: Barking_Mad on November 09, 2007, 12:54:11 am

Title: Help - Documentation Comment Block - Function & Use
Post by: Barking_Mad on November 09, 2007, 12:54:11 am

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)
  */

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?

Title: Re: Help - Documentation Comment Block - Function & Use
Post by: mariocup on November 09, 2007, 12:57:34 am

Hi Barking_Mad,

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

Title: Re: Help - Documentation Comment Block - Function & Use
Post by: Barking_Mad on November 09, 2007, 12:58:14 am

Thanks, will do.