A documentation file should also be created in the documentation folder and be named hal_[MCU_NAME].h, for example, hal_msp430f5529.h. This file should include notes about using the library with the given processor. For example, with the PIC32MX or PIC32MZ series a user can let the library handle the peripheral pin select features with macros:

#define UART1_TX_PIN RPA7

#define UART1_RX_PIN RPA8

The processor specific documentation should also include warnings for any unsupported modules.