News:

Accounts with zero posts and zero activity during the last months will be deleted periodically to fight SPAM!

Main Menu

Help - Documentation Comment Block - Function & Use

Started by Barking_Mad, November 09, 2007, 12:54:11 AM

Previous topic - Next topic

Barking_Mad

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


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

Hi Barking_Mad,

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

Barking_Mad

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