Autoplay
Autocomplete
Previous Lesson
Complete and Continue
Advanced Firmware Documentation with Doxygen
Firmware Documentation
Importance of Documentation in Firmware Development (2:23)
Tools and Resources Needed
Getting Started with Doxygen
Overview of Doxygen (1:52)
Setting Up Doxygen (3:31)
Setting Up the Integrated Development Environment(IDE)
Source Code Download
Downloading CubeIDE (2:34)
Installing CubeIDE (2:38)
Getting the required documentation (7:41)
Getting the required package for bare-metal development (21:19)
Testing the project setup (15:54)
Working with Doxygen
Some Best Practises (2:37)
Understanding the Doxygen Syntax (4:40)
Implementing the Main Page (4:00)
Commenting Embedded C Projects for Documentation Generation
Programming: Analyzing the Board Support Package(BSP) Project (7:23)
Implementing Recommended Folder Structures for Proper Documentation (9:42)
Programming: Commenting the BSP Module for Documentation Generation (6:32)
Programming: Commenting the BSP Function Implementations (8:24)
Programming: Commenting the BSP Function Declarations (5:17)
Programming: System Modules- Commenting the FPU Interface File (5:32)
Programming: System Modules- Commenting the FPU Implementation File (2:47)
Programming: System Modules- Commenting the Timebase Interface File (5:53)
Programming: System Modules- Commenting the Timebase Implementation File (12:15)
Programming: Commenting the Main Module (7:06)
Generating Documentation for Embedded C Projects with Doxygen
Programming: Generating our first Documentation (11:06)
Programming: Analyzing the Documentation (5:46)
Programming: Improving the Navigation (1:20)
Programming: Writing and Integrating the Main Page (7:16)
Programming: Generating Documentation for ST and ARM Header Files (7:18)
Commenting Embedded C++ Projects for Documentation Generation
Programming: Configuring the C++Project (8:28)
Programming: Analyzing the LED Class (6:40)
Programming: Commenting the LED Interface File for Documentation (14:54)
Programming: Commenting the LED Class Methods (9:41)
Programming: Analyzing the Medical LED Module (3:30)
Programming: Commenting the Medical LED Interface File (5:21)
Programming: Commenting the Medical LED Implemtation File (4:08)
Programming: Analyzing the Power LED Module (3:30)
Programming: Commenting the Power LED Interface File (10:22)
Programming: Commenting the Power LED Implementation File (4:32)
Programming: Integrating the UART Module (5:04)
Programming: Commenting the Main Function (8:23)
Generating Documentation for Embedded C++ Projects with Doxygen
Programming: Generating the Documentation for the C++ LED Project (9:14)
Programming: Implementing the Main Page and Optimising for C++ (5:22)
Working with Other Output Formats
Generating the Documentation in PDF Format (11:22)
Course Update
Notice
Teach online with
Importance of Documentation in Firmware Development
Lesson content locked
If you're already enrolled,
you'll need to login
.
Enroll in Course to Unlock