II.
LibraryProcess overview
Reference · livelib-process:embedded-systems--firmware-api-documentation
specializations/embedded-systems/firmware-api-documentation overview
Firmware API Documentation - Generating comprehensive API documentation for firmware modules including function descriptions, parameter specifications, usage examples, and integration guides using tools like Doxygen.
Attributes
displayName
specializations/embedded-systems/firmware-api-documentation
description
Firmware API Documentation - Generating comprehensive API documentation for firmware modules including
function descriptions, parameter specifications, usage examples, and integration guides using tools like Doxygen.
libraryPath
library/specializations/embedded-systems/firmware-api-documentation.js
specialization
embedded-systems
references
- - Doxygen Guide: https://www.doxygen.nl/manual/
- - API Documentation Best Practices: https://embeddedartistry.com/blog/2018/04/09/documenting-your-embedded-c-api/
- - Code Comments: https://interrupt.memfault.com/blog/better-firmware-documentation
example
const result = await orchestrate('specializations/embedded-systems/firmware-api-documentation', {
projectName: 'FirmwareSDK',
sourceDirectories: ['src/drivers', 'src/hal', 'src/lib'],
documentationTool: 'doxygen',
outputFormat: 'html'
});
usesAgents
- firmware-architect
- embedded-tech-writer
Outgoing edges
lib_applies_to_domain1
- domain:embedded-systems·DomainEmbedded Systems
lib_belongs_to_specialization1
- specialization:embedded-systems·Specialization
lib_implements_workflow1
- workflow:firmware-release-cycle·WorkflowFirmware Release Cycle
lib_involves_role1
- role:embedded-engineer·RoleEmbedded Engineer
lib_requires_skill_area3
- skill-area:rtos-programming·SkillAreaRTOS Programming
- skill-area:firmware-development·SkillAreaFirmware Development
- skill-area:api-doc-generation·SkillAreaAPI Doc Generation
uses_agent2
- lib-agent:embedded-systems--firmware-architect·LibraryAgentfirmware-architect
- lib-agent:embedded-systems--embedded-tech-writer·LibraryAgentembedded-tech-writer
Incoming edges
None.