develop:doc:doxygen:docblocks

차이

문서의 선택한 두 판 사이의 차이를 보여줍니다.

차이 보기로 링크

--- develop:doc:doxygen:docblocks [2011/07/19 10:48]
starlits
+++ develop:doc:doxygen:docblocks [2011/07/19 11:58]
starlits
@@ 줄 210: / 줄 210: @@
 };
 </code> doxygen에 의해 생성되는 해당 HTML 문서를 보려면 [[http://www.stack.nl/~dimitri/doxygen/examples/jdstyle/html/class_test.html |여기]]를 클릭하십시오.
-  - 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.
+  - 대부분의 다른 문서와 달리 doxygen은 정의 앞에 member의 문서(global functions 포함)을 넣을 수 있다. \\ 이 방법을 통해서 문서를 헤더파일 대신 소스파일에 놓을 수 있다. \\ 이 방법은 header를 컴팩트(compact)하게 하고, 문서를 더 많이 직접접근(direct access)하게 하는 맴버의 시행(implementer)을 허락한다. \\ 간략설명은 선언(declaration)전엔 놓일 수 있고, 상세설명은 맴버정의(member definition)전에 놓일 수 있게 절충(compromise)할 수 있다.
 ===== Putting documentation after members =====
@@ 줄 230: / 줄 230: @@
 int var; ///< Brief description after the member
 </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 */
@@ 줄 255: / 줄 253: @@
 ==== 주의사항 ====
-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.

develop/doc/doxygen/docblocks.txt · 마지막으로 수정됨: 2011/07/19 11:59 저자 starlits