• <ins id="pjuwb"></ins>
    <blockquote id="pjuwb"><pre id="pjuwb"></pre></blockquote>
    <noscript id="pjuwb"></noscript>
          <sup id="pjuwb"><pre id="pjuwb"></pre></sup>
            <dd id="pjuwb"></dd>
            <abbr id="pjuwb"></abbr>

            eryar

            PipeCAD - Plant Piping Design Software.
            RvmTranslator - Translate AVEVA RVM to OBJ, glTF, etc.
            posts - 603, comments - 590, trackbacks - 0, articles - 0

            OpenCASCADE Documentation System

            Posted on 2014-09-10 22:30 eryar 閱讀(3629) 評論(0)  編輯 收藏 引用 所屬分類: 2.OpenCASCADE1.PipeCAD
            OpenCASCADE Documentation System

            eryar@163.com

            Abstract. Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages. You can also use doxygen for creating normal documentation, as OpenCASCADE did for its references and user’s guide documents.

            Key Words. OpenCASCADE, Doxygen, Documentation System

            1. Introduction

            Doxygen基本上已經(jīng)成了從C++代碼生成文檔的一個(gè)標(biāo)準(zhǔn)工具。OpenCASCADE就利用Doxygen來根據(jù)源代碼生成References文檔,還利用其生成HTML和PDF格式的User Guide文檔。使用Doxygen來生成文檔,只需要按照一定的格式,就可以自動(dòng)生成看上去比較專業(yè)的文檔。

            本文主要對Doxygen用來生成User Guide的方法做一定的介紹。根據(jù)代碼生成References文檔的方法請參考Doxygen的文檔說明。

            wps_clip_image-32375

            Figure 1.1 Doxygen GUI

            2. Prerequisites

            為了自動(dòng)生成PDF格式的文檔,還需要準(zhǔn)備全如下工具:

            v Doxygen 1.8.4版本及以上;

            v Graphviz的Dot,用來生成文檔中的類圖;

            v MikTeX:用來生成PDF格式的文檔;

            v Inkscape:只有當(dāng)要生成PDF格式中帶有SVG格式的圖片時(shí)需要;

            v MathJax:當(dāng)生成的HTML或CHM中有數(shù)學(xué)公式時(shí)需要;

            這些工具都可以從網(wǎng)上下載得到。

            3. Markdown Support of Doxygen

            Markdown支持是從Doxygen1.8.0開始的,Markdown就是還格式語法的普通文本,由John Gruber編寫,其目的是:

            The design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.

            當(dāng)你按照Markdown格式來寫文檔時(shí),只需要將*.md文件放到文檔文件夾中,Doxygen會自動(dòng)搜索并生成相對應(yīng)的文檔。這里列舉幾個(gè)Markdown的例子。

            3.1 Tables表格

            生成表格可以用如下的文本來表示:

            wps_clip_image-11935

            生成的表格樣式如下圖所示:

            wps_clip_image-20097

            Figure 3.1 Tables in Markdown

            3.2 Code Blocks代碼片段

            使用~~來隔離代碼,若在其帶上后綴名,還將根據(jù)后綴名來給代碼高亮。如下所示為給C++代碼著色:

            wps_clip_image-25213

            Figure 3.2 Code blocks in Markdown

            小段代碼著色也可用標(biāo)記@code和@endcode來標(biāo)記。

            3.3 Images插入圖片

            插入圖片使用如下標(biāo)記:

            wps_clip_image-32143

            Figure 3.3 OCC logo

            4. Conclusion

            使用OCC這種方式來生成文檔,感覺還是很不錯(cuò)的。我就使用這種方式生成了程序IsoAlgo的文檔,看上比較專業(yè),如下圖所示:

            wps_clip_image-20858

            Figure 4.1 IsoAlgo User Guide

             

            久久亚洲AV成人出白浆无码国产| 婷婷伊人久久大香线蕉AV| 久久久国产乱子伦精品作者| 大香伊人久久精品一区二区 | 亚洲AV无码一区东京热久久| 偷偷做久久久久网站| 国产一久久香蕉国产线看观看 | 久久狠狠高潮亚洲精品| 99久久婷婷免费国产综合精品| 精品九九久久国内精品| 亚洲欧洲久久av| 久久九九亚洲精品| 久久久久久伊人高潮影院| 亚洲国产精久久久久久久| 亚洲国产精品综合久久网络| 国内精品伊人久久久久AV影院| 品成人欧美大片久久国产欧美...| 久久久久99这里有精品10| 国产精品久久久天天影视| 久久91精品国产91久| 精品免费久久久久国产一区| 久久久久久国产精品美女| 精品国产婷婷久久久| 波多野结衣中文字幕久久| 久久无码中文字幕东京热 | 无码乱码观看精品久久| 久久精品蜜芽亚洲国产AV| 日韩一区二区三区视频久久| 亚洲成人精品久久| 99久久99久久精品免费看蜜桃| 狠狠色丁香久久婷婷综合_中| 国产精品欧美久久久久天天影视| 狠狠精品久久久无码中文字幕| 久久青青草原精品国产软件| 欧美777精品久久久久网| 无码国内精品久久人妻麻豆按摩 | 久久性生大片免费观看性| 亚洲乱亚洲乱淫久久| 国产精品毛片久久久久久久| 久久久久高潮毛片免费全部播放| 欧美激情一区二区久久久|