How to view the markup language in example source code?

Go To Last Post
2 posts / 0 new
Author
Message
#1
  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

In all the .c and .h files in the example code provided for something like the XPLAINED PRO, I see lots of markup language in the initial comment block with things like /enddot /def and, for example, this big block:

 

\subsection asfdoc_sam0_port_module_overview_physical Physical Connection
 *
 * \ref asfdoc_sam0_port_module_int_connections "The diagram below" shows how
 * this module is interconnected within the device.
 *
 * \anchor asfdoc_sam0_port_module_int_connections
 * \dot
 * digraph overview {
 *   node [label="Port Pad" shape=square] pad;
 *
 *   subgraph driver {
 *     node [label="Peripheral MUX" shape=trapezium] pinmux;
 *     node [label="GPIO Module" shape=ellipse] gpio;
 *     node [label="Other Peripheral Modules" shape=ellipse style=filled fillcolor=lightgray] peripherals;
 *   }
 *
 *   pinmux -> gpio;
 *   pad    -> pinmux;
 *   pinmux -> peripherals;
 * }
 * \enddot

Obviously this looks like it should be providing formatting tips for some sort of interpreting program like an XML viewer. But when I use Firefox it doesn't get parsed. How can I read these properly? In the example above it has "shape=ellipse" and so forth - how can I display those shapes?

  • 1
  • 2
  • 3
  • 4
  • 5
Total votes: 0

The markup is used to generate the documentation which is here

http://asf.atmel.com/docs/latest/

For example I can select SAMD21 there and find the port documentation you have quoted:

 

http://asf.atmel.com/docs/latest...

/Lars