doxygen 예제 코드

Tools 2008/06/25 18:13
출처 :  http://gfc3.springnote.com/pages/333455


  1. /**
  2. @file PropertiesUtil.h
  3. @brief CPropertiesUtil 클래스 선언 헤더
  4. */
  5. #if !defined(AFX_PROPERTIESUTIL_H__5B7DF824_3F5A_47F6_9AD3_A287733C8379__INCLUDED_)
  6. #define AFX_PROPERTIESUTIL_H__5B7DF824_3F5A_47F6_9AD3_A287733C8379__INCLUDED_
  7. #if _MSC_VER > 1000
  8. #pragma once
  9. #endif // _MSC_VER > 1000
  10. #include <afxtempl.h>"stdafx.h"
  11. #define PROPERTY_LOAD_SUCCESS 1 /**< 파일 파싱까지 성공함 */
  12. #define PROPERTY_LOAD_FILE_FAILED 0 /**< 파일 로드에 실패함 */
  13. #define PROPERTY_ERROR_LINE_MUL -1 /**< 여기에 * n(에러 행 번호) 해서 리턴하게 됨 */
  14. /**
  15. @brief 설정 파일을 읽어서 보관하는 클래스
  16. 설정 파일의 구조는 다음과 같다.
  17. - 첫 글자가 # 이면 그 라인은 주석
  18. - 빈 라인은 대상이 되지 않음
  19. - '속성 = 값' 으로 이루어진다.
  20. */
  21. class AFX_EXT_CLASS CPropertiesUtil
  22. {
  23. public:
  24. /**
  25. * @brief 생성자\n
  26. * 아무 일도 하지 않는다.
  27. *
  28. */
  29. CPropertiesUtil();
  30. /**
  31. * @brief 소멸자\n
  32. * 아무 일도 하지 않는다.
  33. *
  34. */
  35. virtual ~CPropertiesUtil();
  36. /**
  37. @brief 설정 파일을 읽어들여서 파싱하고 각 설정들을 저장
  38. @param szFileName 읽어들일 설정 파일 이름
  39. @return 에러 유무
  40. @see PROPERTY_ERROR_LINE_MUL
  41. @see PROPERTY_LOAD_FILE_FAILED
  42. @see PROPERTY_LOAD_SUCCESS
  43. */
  44. int LoadFile(const char * szFileName);
  45. /**
  46. @brief 속성에 해당하는 값을 맵에서 찾아서 전달인자에 설정
  47. @param szKey 속성 이름
  48. @param csValue 속성에 해당하는 값
  49. @return 속성의 존재 유무
  50. */
  51. BOOL GetMatchedValue(const char * szKey, CString & csValue);
  52. private:
  53. CMapStringToString m_mapKeyToVal; /**< 키와 값을 매핑시킨 객체 */
  54. };
  55. #endif // !defined(AFX_PROPERTIESUTIL_H__5B7DF824_3F5A_47F6_9AD3_A287733C8379__INCLUDED_)