Try them out by modifying the source code and see the diagram instantly rendering below. Packet diagram / packetdiag - NVS Page Structure Sequence diagram / seqdiag - Scan for a Specific AP in All Channels Slightly more complicated block diagram - Wi-Fi programming model Simple block diagram / blockdiag - Wi-Fi Buffer Configuration The diagram code is then converted into “.png” graphics and integrated “behind the scenes” into Sphinx documents.įor the diagram preparation you can use an on-line interactive shell that instantly shows the rendered image. The diagram elements are laid out automatically. With this suite of tools it is possible to generate beautiful diagram images from simple text format (similar to graphviz’s DOT format). The following types of diagrams are supported: This repository is using blockdiag suite of tools to generate diagram images from simple text files. Sometimes it is better to add an illustration than writing a lengthy paragraph to describe a complex idea, a data structure or an algorithm. :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dirĬonsider adding diagrams and pictures to illustrate described concepts. :example_file:`path` - points to file inside ESP-IDF examples dir :example:`path` - points to directory inside ESP-IDF examples dir :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir :component_file:`path` - points to file inside ESP-IDF components dir :component:`path` - points to directory inside ESP-IDF components dir :idf_raw:`path` - points to raw view of the file inside ESP-IDF :idf_file:`path` - points to file inside ESP-IDF :idf:`path` - points to directory inside ESP-IDF This is needed to ensure that links do not get broken when files in master branch are moved around or deleted. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. doxygen will include brief member descriptions after the members that are. Instead, use docutils custom roles that will generate links for you. All text after a double hash () is considered a comment and is placed in. When linking to examples on GitHub do not use absolute / hardcoded URLs.
0 Comments
Leave a Reply. |