EMBEDDED TOOLKIT

SYSTEMS R&D // DEV_TOOLS SUITE

Tools (65)

register documentation generator

SYSTEM ONLINE

Register Metadata

Field Definition (Bitfields)

BITSNAMEACCESSDESCRIPTIONACTION
15OVER8R/WOversampling mode
13UER/WUSART enable
12MR/WWord length
3TER/WTransmitter enable
2RER/WReceiver 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:12 or a single bit 3.
  • 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.