| 양쪽 이전 판
이전 판
다음 판
|
이전 판
마지막 판
양쪽 다음 판
|
develop:doc:doxygen:docblocks [2011/07/19 10:25]
starlits |
develop:doc:doxygen:docblocks [2011/07/19 11:58]
starlits |
| int (*handler)(int a,int b); | int (*handler)(int a,int b); |
| }; | }; |
| </code> Click [[http://www.stack.nl/~dimitri/doxygen/examples/qtstyle/html/class_test.html | here ]] for the corresponding HTML documentation that is generated by doxygen. | </code> doxygen에 의해 생성되는 해당 HTML 문서를 보려면 [[http://www.stack.nl/~dimitri/doxygen/examples/qtstyle/html/class_test.html |여기]]를 클릭하십시오. |
| | - 멀티 라인 주석 블록에 대한 자세한 설명을 포함하는 반면 한 라인 주석은 간단한 설명이 포함되어 있습니다. |
| | - 간략설명(brief descriptions)은 class, namespace, file 의 멤버 개요가 포함되어 있으며 작은 기울임꼴 글꼴을 사용하여 인쇄됩니다 (이 설명은 설정파일에서 BRIEF_MEMBER_DESC 값이 NO로 숨길 수 있습니다.) \\ 기본적으로 간략설명은 상세설명의 첫문장에 옵니다. (그러나 REPEAT_BRIEF 값을 NO로 변경할 수 있습니다). \\ 간략설명과 상세설명 모두 Qt 스타일의 옵션입니다. |
| The one-line comments contain a brief description, whereas the multi-line comment blocks contain a more detailed description. | - 기본적으로 JavaDoc 스타일의 문서 블록은 Qt는 스타일 문서 블록과 같은 방식으로 동작합니다. JavaDoc은 명시적으로 문서의 첫번째 블록에 간략설명되지 않아도 상관없다.(This is not according the JavaDoc specification however, where the first sentence of the documentation block is automatically treated as a brief description.) 이 동작을 사용하려면 JAVADOC_AUTOBRIEF 을 YES로 설정해야 한다. \\ 만약 이 옵션을 활성화하고 끝나지 않은 문장의 중간에 점(dot)을 넣으려는 경우에는, 점뒤에 백슬래시(backslash)와 공간(space)를 붙여야 합니다. 그 예이다: <code> |
| | |
| | |
| The brief descriptions are included in the member overview of a class, namespace or file and are printed using a small italic font (this description can be hidden by setting BRIEF_MEMBER_DESC to NO in the config file). By default the brief descriptions become the first sentence of the detailed descriptions (but this can be changed by setting the REPEAT_BRIEF tag to NO). Both the brief and the detailed descriptions are optional for the Qt style. | |
| | |
| | |
| By default a JavaDoc style documentation block behaves the same way as a Qt style documentation block. This is not according the JavaDoc specification however, where the first sentence of the documentation block is automatically treated as a brief description. To enable this behaviour you should set JAVADOC_AUTOBRIEF to YES in the configuration file. If you enable this option and want to put a dot in the middle of a sentence without ending it, you should put a backslash and a space after it. Here is an example: <code> | |
| /** Brief description (e.g.\ using only a few words). Details follow. */ | /** Brief description (e.g.\ using only a few words). Details follow. */ |
| </code> | </code> |
| | - Here is the same piece of code as shown above, this time documented using the JavaDoc style and JAVADOC_AUTOBRIEF set to YES: <code> |
| Here is the same piece of code as shown above, this time documented using the JavaDoc style and JAVADOC_AUTOBRIEF set to YES: <code> | |
| /** | /** |
| * A test class. A more elaborate class description. | * A test class. A more elaborate class description. |
| }; | }; |
| </code> doxygen에 의해 생성되는 해당 HTML 문서를 보려면 [[http://www.stack.nl/~dimitri/doxygen/examples/jdstyle/html/class_test.html |여기]]를 클릭하십시오. | </code> doxygen에 의해 생성되는 해당 HTML 문서를 보려면 [[http://www.stack.nl/~dimitri/doxygen/examples/jdstyle/html/class_test.html |여기]]를 클릭하십시오. |
| | - 대부분의 다른 문서와 달리 doxygen은 정의 앞에 member의 문서(global functions 포함)을 넣을 수 있다. \\ 이 방법을 통해서 문서를 헤더파일 대신 소스파일에 놓을 수 있다. \\ 이 방법은 header를 컴팩트(compact)하게 하고, 문서를 더 많이 직접접근(direct access)하게 하는 맴버의 시행(implementer)을 허락한다. \\ 간략설명은 선언(declaration)전엔 놓일 수 있고, 상세설명은 맴버정의(member definition)전에 놓일 수 있게 절충(compromise)할 수 있다. |
| | |
| | |
| Unlike most other documentation systems, doxygen also allows you to put the documentation of members (including global functions) in front of the definition. This way the documentation can be placed in the source file instead of the header file. This keeps the header file compact, and allows the implementer of the members more direct access to the documentation. As a compromise the brief description could be placed before the declaration and the detailed description before the member definition. | |
| |
| ===== Putting documentation after members ===== | ===== Putting documentation after members ===== |
| int var; ///< Brief description after the member | int var; ///< Brief description after the member |
| </code> | </code> |
| | - Note that these blocks have the same structure and meaning as the special comment blocks in the previous section only the < indicates that the member is located in front of the block instead of after the block. |
| Note that these blocks have the same structure and meaning as the special comment blocks in the previous section only the < indicates that the member is located in front of the block instead of after the block. | - Here is an example of the use of these comment blocks: <code> |
| | |
| Here is an example of the use of these comment blocks: <code> | |
| /*! A test class */ | /*! A test class */ |
| |
| |
| ==== 주의사항 ==== | ==== 주의사항 ==== |
| These blocks can only be used to document members and parameters. They cannot be used to document files, classes, unions, structs, groups, namespaces and enums themselves. Furthermore, the structural commands mentioned in the next section (like \class) are ignored inside these comment blocks. | - These blocks can only be used to document members and parameters. They cannot be used to document files, classes, unions, structs, groups, namespaces and enums themselves. Furthermore, the structural commands mentioned in the next section (like \class) are ignored inside these comment blocks. |
| |
| |
