• <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

             

            97精品国产97久久久久久免费| 久久精品亚洲福利| 色偷偷88888欧美精品久久久| 91精品国产色综合久久| 久久综合色老色| 热久久这里只有精品| 久久精品国产亚洲精品2020| 久久精品极品盛宴观看| 亚洲精品高清国产一线久久| 亚洲人成无码www久久久| 99久久99久久精品国产片| 国内精品久久久久久野外| 欧美牲交A欧牲交aⅴ久久| 久久精品一区二区国产| 一本久久综合亚洲鲁鲁五月天亚洲欧美一区二区 | 久久夜色撩人精品国产小说| 2021少妇久久久久久久久久| 久久久久久国产a免费观看不卡| 久久久久亚洲av成人网人人软件 | 久久精品成人免费国产片小草| 久久久久久伊人高潮影院| 久久777国产线看观看精品| 综合久久国产九一剧情麻豆| 久久久久国产一级毛片高清板| 一本色道久久综合狠狠躁 | 伊人久久大香线蕉亚洲| 色偷偷91久久综合噜噜噜噜| 亚洲欧美国产日韩综合久久| 青青青青久久精品国产| 久久精品九九亚洲精品天堂| 久久99久久99精品免视看动漫| 亚洲欧洲中文日韩久久AV乱码| 久久se精品一区精品二区国产 | 99久久久精品免费观看国产| 国产产无码乱码精品久久鸭| 中文字幕乱码人妻无码久久| 久久久久亚洲爆乳少妇无 | 久久强奷乱码老熟女| 久久久久人妻一区精品| 精品乱码久久久久久夜夜嗨| 秋霞久久国产精品电影院|