2008. 6. 15. 13:32

Doxygen 주석 활용 [VC++ 스타일]

//////////////////////////////////////////////////////////////////////////
/// @brief  Test Class for an example of doxygen usage
/// @remark  More Information
/// @author  Jihoon.Yim
/// @version V1.0
/// @date  3/21/2008
//////////////////////////////////////////////////////////////////////////
/// @note  I changed my mind.
/// @todo  I will have to think more complex design on this class.
class Test
{
 int Add(int i, int j);
 int Sum(int i, int j);
};

//////////////////////////////////////////////////////////////////////////
/// @brief  Add two parameters and then return the sum
/// @param  i Integer value
/// @param  j Integer value
/// @exception Throws an exception when error occurs.
/// @return  Return (i+j)
/// @retval  -1 Failed to add
/// @remark  More Information
///    - Item 1
///     -# Sub Item 1
///     -# Sub Item 2
///     .
///    - Item 2
///    .
/// @code
/// int i=3;
/// int j=3;
/// try
/// {
///  int result = Add(i, j);
/// }
/// catch
/// {
///  ...
/// }
/// @endcode
/// @author  Jihoon.Yim (A company)
/// @author  Gildong.Hong (B consulting company)
/// @date  3/21/2008
//////////////////////////////////////////////////////////////////////////
/// @bug  [Fixed 3/22/2008 Jihoon.Yim] That was not correct in some cases.
/// @bug  [Fixed 3/21/2008 Jihoon.Yim] I forgot some calculation. (Fixed 3/23/2008)
/// @warning Watch out when using this class.

int Test::Add(int i, int j)
{
 return (i+j);
}


//////////////////////////////////////////////////////////////////////////
/// @brief  Add two parameters and then return the sum
/// @param  i Integer value
/// @param  j Integer value
/// @return  Return (i+j)
/// @retval  -1 Failed to add
/// @author  Jihoon.Yim
/// @date  3/21/2008
//////////////////////////////////////////////////////////////////////////
int Test::Sum(int i, int j)
{
 return (i+j);
}