blocks¶
-
- Complete working programs
-
- Practical usage demonstrations
-
- Pages Tab:
-
- OLED Usage Guide (comprehensive guide)
-
- OLED Examples (10+ code samples)
-
- OLED Namespace (namespace organization)
-
- OLED Documentation Summary (this page)
-
- Namespaces Tab:
-
- CFBD - Core Framework Bare Device
-
- CFBD::OLED - OLED Display Driver
-
Documentation Guidelines¶
-
- The documentation follows these principles:
-
-
- Completeness: All public APIs are documented
-
-
- Clarity: Technical terms are explained
-
- Examples: Practical code examples included
-
- Cross-referencing: Related concepts are linked
-
- Hierarchy: Information is organized logically
-
- Audience: Both beginners and advanced users are served
-
Generating Documentation¶
-
- To generate the Doxygen documentation:
-
bash
doxygen Doxyfile *-
- The output will be generated in the configured directory (typically
documentation/).
- The output will be generated in the configured directory (typically
-
- Key configuration points in Doxyfile:
-
- EXAMPLE_PATH: Directory containing example files
-
- GENERATE_HTML: HTML output generation
-
- GENERATE_LATEX: PDF generation
-
- EXTRACT_ALL: Whether to document all entities
-
Related Resources¶
-
-
- OLED Driver Usage Guide - Comprehensive guide for developers
-
-
- Code Examples - 10+ practical examples
-
- README.md - Project overview and build instructions
-
- Doxyfile - Doxygen configuration
-
Maintaining Documentation¶
-
- When adding new features to the OLED driver:
-
-
- Add comprehensive comments to header files
-
-
- Use ```
Filename: blocks
Updated on 2026-02-03 at 13:21:55 +0000