¼öÁ¤³úÀÇ À§Å°
Doxygen: Source code documentation generator tool

Contents

1 ¼³Ä¡
2 ½ÇÇà ¹× ±âº»¼³Á¤
3 ¹«Á¶°Ç ÇØº¸±â
3.1 ¼³Á¤ÃʱâÈ­
3.2 Wizard¸¦ ÀÌ¿ëÇÑ ±âº»¼³Á¤
3.3 Expert¸¦ ÀÌ¿ëÇÑ ¼¼ºÎ¼³Á¤(Çѱۼ³Á¤)
3.4 ÀÛ¾÷°æ·Î ÁöÁ¤(Step3)
3.5 ¹®¼­»ý¼º(Step4)
3.6 »ý¼ºµÈ ¹®¼­º¸±â
3.7 ´Ù¾çÇÑ ÀÌ¿ë¹æ¹ý
4 ¼³Á¤ÆÄÀÏ ¼¼ºÎÇ׸ñ

1 ¼³Ä¡ #

  • ´Ù¿î·Îµå: http://www.doxygen.org ¿¡¼­ download ÆäÀÌÁö ÀÌ¿ë
  • ¼³Ä¡: ¼³Ä¡ÆÄÀÏ ½ÇÇà (¿¹:doxygen-1.5.4-setup.exe)
    {i} ¼³Ä¡°ü·ÃÇØ¼­ ¾î·Á¿ï°Ô ¾ø½À´Ï´Ù. :)

2 ½ÇÇà ¹× ±âº»¼³Á¤ #

  • "½ÃÀÛ"¸Þ´º ¡æ "¸ðµçÇÁ·Î±×·¥" ¡æ "doxygen" ¡æ "Doxywizard"
  • doxygenÀ» À§ÇÑ ±âº» ¼³Á¤ÆÄÀÏ »ý¼º

    • doxygen ÀÌ¿ë¹æ¹ý
      -DOSâ¿¡¼­ ¾Æ·¡¿Í °°ÀÌ ¸í·É»ç¿ë
      c:\program files\doxygen\bin\doxygen -s -g configfilename
      
      -s¿É¼Ç: ÁÖ¼®¾øÀÌ ¼³Á¤ÆÄÀÏ »ý¼º ( (!) ¼³Á¤º¯¼öÀÇ Àǹ̸¦ ¾Ë°í½Í´Ù¸é ÀÌ ¿É¼ÇÀ» »©°í »ý¼ºÇغ¸ÀÚ. )
      -g¿É¼Ç: ÀÌ¿É¼Ç ¹Ù·ÎµÚ¿¡ ÁöÁ¤µÈ ÆÄÀϸíÀ¸·Î ¼³Á¤ÆÄÀÏÀ» ÀÛ¼º (±âº»°ª)
      (Âü°í: 'doxygen -g -s configfilename' ¸í·ÉÀº À߸øµÈ °æ¿ì·Î ÆÄÀϸíÀº Doxyfile·Î ÁöÁ¤µÊ)

    • doxywizard ÀÌ¿ë¹æ¹ý (ÀÌ°Ô ½±ÁÒ |) )
      -'ÆÄÀÏ'¸Þ´º¿¡¼­ 'Reset'¼±ÅÃ

3 ¹«Á¶°Ç ÇØº¸±â #

  • VC++ 6.0 ¼Ò½º·Î Àû¿ëÇØ¼­ ÇØº¸±â

3.1 ¼³Á¤ÃʱâÈ­ #

  • 'File'¸Þ´º¡æ'Reset'

3.2 Wizard¸¦ ÀÌ¿ëÇÑ ±âº»¼³Á¤ #

  • ProjectÅÇ
    - Project name: ¹®¼­Á¦¸ñÀÌ´Ù. ÇÁ·Î±×·¥¸íÀ̳ª ÇÁ·ÎÁ§Æ®¸íÀ» ÀÔ·Â
    - Project version or id: v1.0 °ú °°ÀÌ ¹®¼­¹öÀüÀ̳ª ºÎÁ¦¸¦ ÀÔ·Â
    - /!\ ÇÁ·ÎÁ§Æ®¸í°ú ¹öÀüÁ¤º¸´Â ÇѱÛÀ» Áö¿øÇÏÁö ¾Ê´Â´Ù. :(
    - Source code directory: [Select]¸¦ ÀÌ¿ëÇÏ¿© ¼Ò½ºÆÄÀÏÀÇ Æú´õ¸¦ ÁöÁ¤
    - Scan recursively: À§¿¡¼­ ÁöÁ¤ÇÑ ¼Ò½ºÆú´õÀÇ ÇÏÀ§Æú´õ ÆÄÀÏ Æ÷ÇÔ¿©ºÎ (üũÇÏÀÚ)
    - Destination directory: [Select]¸¦ ÀÌ¿ëÇÏ¿© doxygenÀÌ »ý¼ºÇÒ ¹®¼­°¡ ÀúÀåµÉ Æú´õ¸¦ ÁöÁ¤
    - /!\ Æú´õ°æ·Î´Â ¾Æ·¡¿¡¼­ ÁöÁ¤ÇÑ ÀÛ¾÷°æ·Î¸¦ ±âÁØÀ¸·Î »ó´ë°æ·Î¸¦ ÁöÁ¤ÇÒ¼öµµ ÀÖ´Ù.
  • ModeÅÇ
    - Documented entities only: doxygenÀ» À§ÇÑ °¢Á¾ÁöÁ¤ÀÚ°¡ Æ÷ÇԵȰ͸¸ Ãâ·Â¹®¼­¿¡ Æ÷ÇÔÇÏ¿© ÀÛ¼ºÇÑ´Ù´Â ÀǹÌÀÌ´Ù.
    °®°íÀÖ´Â ¼Ò½º¿¡ doxygenÀ» À§ÇØ ¾î¶²ÀÛ¾÷µµ ¾ÈÇßÀ¸´Ï À̿ɼǸ¸À¸·Î´Â Á¦¸ñÆäÀÌÁö¸¸ ÀÖ´Â ¹®¼­¸¸ ¾ò°Ô µÉ°ÍÀÌ´Ù.
    - All entities: doxygenÀÇ ¸ðµç Ãâ·Â¹°À» ÀÛ¼ºÇϵµ·Ï ÁöÁ¤ÇÑ´Ù.
    doxygenÀ» À§ÇÑ ÁöÁ¤ÀÚ°¡ ¾ø´Â ³»¿ëµµ ¹®¼­¿¡ Æ÷ÇÔÇϹǷΠÀÏ´Ü À̳ðÀ» ¼±ÅÃÇÏÀÚ.
    - Include cross-referenced source code in the output: ¼Ò½ºÄڵ带 ¹®¼­¿¡ Æ÷ÇÔÇÑ´Ù.
    HTML¹®¼­¶ó¸é 'File(ÆÄÀϵé)'ÅÇ¿¡ ¼Ò½º¸ñ·Ï ¹× Äڵ带 º¸±âÀ§ÇÑ [Code(ÄÚµå)]¸µÅ©¸¦ Ãß°¡ÇÑ´Ù.
    À§ ¿É¼Ç¿¡¼­ 'All entities'À» ¼±ÅÃÇÏÁö ¾Ê°í 'Documented entities Only'¸¦ ¼±ÅÃÇß´Ù¸é ÀÌ°Å¶óµµ ¼±ÅÃÇÏÀÚ.
    'All entities'¿Í ÇÔ²² üũµÇ¸é Äڵ峻¿¡ °ü·Ã¹®¼­¿ÍÀÇ ¸µÅ©°¡ »ý±ä´Ù.
    - Optimize for C++ output: ¹®¼­´ë»ó ¼Ò½º°¡ VC++À̹ǷΠÀ̳ðÀ» ¼±ÅÃÇÏÀÚ.
  • OutputÅÇ
    - Ãâ·Â¹°ÀÇ Çü½ÄÀ» ÁöÁ¤
    - HTML¸¸ »ý¼ºÇÒ °ÍÀ̹ǷΠHTMLÇ׸ñ¿ÜÀÇ Ãâ·Â¹° üũ¸¦ ¾ø¾ÖÀÚ.
  • DiagramsÅÇ
    - µµ¸éÀÛ¼ºÀ» À§ÇÑ DotÅø(GraphViz)À» À§ÇÑ ¼³Á¤µéÀÌ´Ù.
    - Use built-in class diagram generator: ±âº»¼³Á¤ÀÌ´Ù.
    - Use dot tool from the GraphViz package to generate: DotÅøÀÌ ÀÖÀ¸¸é ¼±ÅÃÇÑ´Ù.
    ¾øÀ¸´Ï ¼±ÅÃÇÏÁö ¸»ÀÚ.
  • [OK]¹öưÀ¸·Î WizardÁ¾·á

3.3 Expert¸¦ ÀÌ¿ëÇÑ ¼¼ºÎ¼³Á¤(Çѱۼ³Á¤) #

  • Expert¼³Á¤Àº ¼³Á¤ÆÄÀÏ ¼¼ºÎÇ׸ñÀ» ÂüÁ¶Ç϶ó.
  • ¿©±â¼­´Â ÇѱÛÇ¥½Ã¸¦ À§ÇÑ ¼³Á¤¸¸ ÇÑ´Ù.
  • ProjectÅÇ
    - OUTPUT_LANGUAGE: Korean¼±ÅÃ
    - OUTPUT_LANGUAGE: Korean-en¼±ÅÃ
    - TAB_SIZE: VC++ ¿¡µðÅÍ¿¡¼­ ¼³Á¤ÇÑ °ªÀ¸·Î ÁöÁ¤
  • InputÅÇ
    - INPUT_ENCODING: EUC-KRÀÔ·Â(¼Ò¹®ÀÚµµ ¹«°ü)
    - EXCLUDE_PATTERNS: ¼Ò½ºÀԷ½à Á¦¿ÜÇÒ °ÍµéÀ» ÆÐÅÏÇüÅ·ΠÁöÁ¤
    °¡·É CVS¸¦ »ç¿ëÇÑ´Ù¸é ¼öÁ¤ÁßÀÎ ¼Ò½ºÀÇ ÆÄÀϻ纻µéÀÌ ÀÖÀ¸¹Ç·Î À̸¦ Á¦¿ÜÇÒ Çʿ䰡 ÀÖ´Ù.
    ÀÔ·Ââ¿¡ */CVS/*¶ó°í ÀÔ·ÂÇÑµÚ [+]¹öưÀ¸·Î Ãß°¡
  • HTMLÅÇ
    - HTML_HEADER: ¾Æ·¡ ³»¿ëÀÇ ÆÄÀÏÀ» ÀÛ¼ºÇÑµÚ ÁöÁ¤ÇÑ´Ù.
    ÆÄÀϸí: euckr-header.html
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    <html><head><meta http-equiv="Content-Type" content="text/html;charset=EUC-KR">
    <title>DVR Server - Class Reference</title>
    <link href="doxygen.css" rel="stylesheet" type="text/css">
    <link href="tabs.css" rel="stylesheet" type="text/css">
    </head><body>
    
  • À§¿Í °°ÀÌ ÇÏ´Â ÀÌÀ¯´Â VC++ÆÄÀÏÀº ¿Ï¼ºÇüÇѱÛÄÚµå(CP949)À̰í DoxygenÀÇ Ãâ·Â¹°Àº À¯´ÏÄÚµå(UTF-8)¸¦ ±âº»À¸·Î ÇÑ´Ù. INPUT_ENCODINGÀ» ÁöÁ¤Çϸé ÇѱÛÀÌ Á¦´ë·Î º¯È¯µÈ´Ù°í ÇÏÁö¸¸ ½ÇÁ¦·Î´Â Ãâ·Â¹° ÀÛ¼ºÁß Äڵ庯ȯ ¿¡·¯°¡ ¹ß»ýÇÏ¿© À§¿Í °°ÀÌ º¹ÀâÇÏ°Ô ÇØ°áÇÏ°Ô µÇ¾ú´Ù.
  • {{{OK]}}¹öưÀ¸·Î ExpertÁ¾·á

3.4 ¼³Á¤ÀúÀå(Step2) #

  • [Save]¹öưÀ¸·Î ¼³Á¤³»¿ëÀ» ÀúÀåÇÏÀÚ.
  • Status: not saved »óÅ¿¡¼­´Â doxygen¹®¼­¸¦ »ý¼ºÇÒ¼ö ¾øµµ·Ï µÇ¾î ÀÖ´Ù.
  • ¼³Á¤ÆÄÀÏ ÀúÀåÀ§Ä¡´Â Wizard¿¡¼­ ÁöÁ¤ÇÑ Destination directory¿¡ ÀúÀåÇÏ´Â °ÍÀÌ ÆíÇÏ´Ù.
    (!) ÆÁ: ¼³Á¤ÆÄÀÏÀ» ÆÄÀϸí.Doxyfile°ú °°Àº ÇüÅ·ΠÀúÀåÇϰí Ž»ö±âÀÇ È®ÀåÀÚ ¿¬°á¼³Á¤¿¡¼­
    DoxyfileÈ®ÀåÀÚ¸¦ Doxywizard¿Í ¿¬°áÇØµÎ¸é Ž»ö±â¿¡¼­ ¼³Á¤ÆÄÀÏÀ» ´õºíŬ¸¯¸¸À¸·Îµµ
    Doxywizard·Î ½ÇÇàÇÒ¼ö°¡ ÀÖ¾î ÆíÇÏ´Ù.

3.5 ÀÛ¾÷°æ·Î ÁöÁ¤(Step3) #

  • Working directory: ÀÛ¾÷Áß »ç¿ëÇÒ ÀÓ½ÃÆÄÀϵéÀÌ ÀúÀåµÉ °æ·Î¸¦ ÁöÁ¤
    [Select]¹öưÀ¸·Î ¾Æ¹«µ¥³ª ÁöÁ¤ÇÏÀÚ.
    À̰æ·Î´Â ÈÄ¿¡ Doxygen¼³Á¤ÆÄÀÏÀ» ·ÎµùÇÒ °æ¿ì ÇØ´ç ¼³Á¤ÆÄÀÏÀÌ À§Ä¡ÇÑ °æ·Î·Î ÀÚµ¿À¸·Î ¹Ù²î¹Ç·Î Ưº°È÷ ½Å°æ¾µ ÇÊ¿ä´Â ¾ø´Ù. ´Ü, ÀԷ¼ҽºÆú´õ¿Í ¹®¼­ÀúÀåÆú´õ¸¦ »ó´ë°æ·Î·Î ÀÔ·ÂÇß´Ù¸é ÀÛ¾÷°æ·Î°¡ ±âÁØÀÌ µÇ¹Ç·Î Á¤È®È÷ ÁöÁ¤ÇÏÀÚ.

3.6 ¹®¼­»ý¼º(Step4) #

  • Step2¿Í Step3ÀÇ ÀÛ¾÷À» ¿Ï·áÇØ¾ß [Start]¹öưÀÌ È°¼ºÈ­ µÉ°ÍÀÌ´Ù.
  • [Start]¹öưÀ¸·Î ¹®¼­ »ý¼º

3.7 »ý¼ºµÈ ¹®¼­º¸±â #

  • HTMLÇüÅ·Π»ý¼ºÇßÀ¸¹Ç·Î ¹®¼­ÀúÀå °æ·Î¾Æ·¡¿¡ htmlÀ̶ó´Â ÇÏÀ§Æú´õ¾È¿¡ ¹®¼­°¡ »ý¼ºµÈ´Ù.
  • htmlÆú´õ¾ÈÀÇ index.htmlÀ» À¥ºê¶ó¿ìÀú·Î Àд´Ù.
  • Ŭ·¡½º Á¤º¸µéÀÌ Æ÷ÇÔµÈ ¹®¼­°¡ ÀÛ¼ºµÇ¾úÀ» °ÍÀÌ´Ù.

3.8 ´Ù¾çÇÑ ÀÌ¿ë¹æ¹ý #

  • À̰͸¸À¸·Îµµ ´ë´ÜÇÏÁö¸¸ Á»´õ ¹®¼­´Ù¿î ¹®¼­¸¦ ÀÛ¼ºÇϰíÀÚ ÇÑ´Ù¸é doxygenÀ» À§ÇÑ ÁöÁ¤ÀÚ¸¦ ÀÌ¿ëÇØ¾ß ÇÒ °ÍÀÌ´Ù.

4 ¼³Á¤ÆÄÀÏ ¼¼ºÎÇ׸ñ #


성중
Login:
Password:
Join
You have a deep appreciation of the arts and music.

Valid XHTML 1.0! Valid CSS! powered by MoniWiki
last modified 2008-04-24 15:38:59
Processing time 0.3545 sec