EMBEDDED TOOLKIT
SYSTEMS R&D // DEV_TOOLS SUITE
Tools (65)
register documentation generator
SYSTEM ONLINE
Register Metadata
Field Definition (Bitfields)
| BITS | NAME | ACCESS | DESCRIPTION | ACTION |
|---|---|---|---|---|
| 15 | OVER8 | R/W | Oversampling mode | |
| 13 | UE | R/W | USART enable | |
| 12 | M | R/W | Word length | |
| 3 | TE | R/W | Transmitter enable | |
| 2 | RE | R/W | Receiver enable |
📖 How to use Register Documentation Generator?
Register Documentation Generator is an editor for engineers writing libraries and specifications using Doxygen, GitHub, or a regular Notepad. It is used to automatically carve beautiful Markdown tables based on hardware field definitions.
1. Definition and Metadata
- Enter the register name, its offset in the memory map, and the value the microcontroller starts with (Reset Value) in the left panel.
- This data will be formatted at the top of the generated Markdown file.
2. Adding Fields and Generating Git-Markdown
- Write down the bit structure in the right pane. Provide the range e.g. as
15:12or a single bit3. - In the text field (Terminal) at the bottom, an editable Markdown table is created on the fly with alignments, ready to paste into README.md on GitHub or into a Doxygen block in your `*.h` header.