Opencascade Documentation System

Opencascade Documentation System

[Email protected]

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 has basically become a standard tool for generating documents from C ++ code. Opencascade uses doxygen to generate a references document based on the source code, and uses it to generate user guide documents in HTML and PDF formats. To use doxygen to generate documents, you only need to follow a certain format to automatically generate seemingly professional documents.

This article describes how to generate a user guide using doxygen. For more information about how to generate a references document based on the code, see doxygen documentation.

Figure 1.1 doxygen Gui

2. Prerequisites

To automatically generate PDF documents, you also need to prepare the following tools:

V doxygen 1.8.4 or later;

V graphviz dot, used to generate class diagrams in the document;

V miktex: used to generate documents in PDF format;

V inkscape: It is only required to generate images with SVG in pdf format;

V mathjax: required when the generated HTML or CHM contains mathematical formulas;

These tools can be downloaded from the Internet.

3. markdown support of doxygen

Markdown supports doxygen1.8.0 and markdown is a common text in the format syntax. It is written by 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 shocould 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.

When you write a document in markdown format, you only need to put the *. md file in the document folder. doxygen will automatically search for and generate the corresponding document. Here are several markdown examples.

3.1 Tables Table

The generated table can be represented in the following text:

Shows the style of the generated table:

Figure 3.1 Tables in markdown

3.2 code blocks code snippet

Use ~~ To isolate the Code. If a suffix is added to the code, the code is highlighted Based on the suffix. Color the C ++ Code as follows:

Figure 3.2 code blocks in markdown

The @ code and @ endcode can also be used to mark the code coloring.

3.3 insert images into images

Insert an image with the following mark:

Figure 3.3 OCC logo

4. Conclusion

It is nice to use OCC to generate documents. I used this method to generate the isoalgo program documentation. It looks more professional, as shown in:

Figure 4.1 isoalgo User Guide

 

Pdf version: opencascade Documentation System

Opencascade Documentation System