Author Topic: Help - Documentation Comment Block - Function & Use  (Read 4308 times)

Offline Barking_Mad

  • Multiple posting newcomer
  • *
  • Posts: 47
Help - Documentation Comment Block - Function & Use
« 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?
WooF! WooF! - Ubuntu 8.10 & CB 5432 & GCC 4.3.2
To see the world in a grain of sand and heaven in a wild flower
To hold infinity in the palm of your hand and eternity in an hour - W.B

mariocup

  • Guest
Re: Help - Documentation Comment Block - Function & Use
« Reply #1 on: November 09, 2007, 12:57:34 am »
Hi Barking_Mad,

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

Offline Barking_Mad

  • Multiple posting newcomer
  • *
  • Posts: 47
Re: Help - Documentation Comment Block - Function & Use
« Reply #2 on: November 09, 2007, 12:58:14 am »
Thanks, will do.
WooF! WooF! - Ubuntu 8.10 & CB 5432 & GCC 4.3.2
To see the world in a grain of sand and heaven in a wild flower
To hold infinity in the palm of your hand and eternity in an hour - W.B