doxygen-header.h

//File comment
/**
 * @file headerfile.h
 * @author my name
 * @date 31 Mar 2017
 * @brief A bried description of headfile.h
 *
 * A more detailed descriptions goes here.
 * Bla bla
 * bla bla
 *
 * @see https://www.google.com
 *
 */

/** 
* @author my name
* @date 31 Mar 2017
* @brief My color enum type.
*
* It defines color values.
*
*/
typedef enum MyColor_enum
{
  MyColor_RED,  /**< red color */

  MYCOLOR_GREEN, //!< green color

  //! blue color
  MYCOLOR_BLUE,

  /** black color */
  MYCOLOR_BLACK,
} MyColor;



/**
* @brief A function, bla bla bla...
* 
* Detailed description, bla bla bla....
*
* @param color1 [in]  bla bla...
* @param str1   [in]  bla bla...
* @param int1   [out] bla bla ....
* @param f      [in,out] bla bla....
* @return bla bla
* @warning this is a warning
* @note some notes goes here.
* @todo some to do list
*/
MyColor 
myFunction(MyColor color1, const std::string &str1, int &int1, float &f);


// groups

//=========================================================
// DOXYGEN Group my_first_group
//---------------------------------------------------------
//! @defgroup my_first_group My first group
//! This is my first group.
//! 
//! @{
//!

// everything here belongs to my_first_group

//! @}


//=========================================================
// DOXYGEN Group my_first_sub_group
//---------------------------------------------------------
//! @defgroup my_first_sub_group My first sub group
//! @ingroup my_first_group
//! My first sub group that in my_first_sub_group
//! This is my first group.