doxygen_groups.h

Go to the documentation of this file.

#pragma once
 
/// @file doxygen_groups.h
/// @brief Doxygen group definitions for the Home IO Control component.
/// @ingroup hioc_arch
 
/// @defgroup hioc_arch Architecture Layers
/// @brief High-level documentation groups for the Home IO Control component.
///
/// These groups organize the generated documentation around the main layers of the
/// project instead of only by file names. This makes it easier to move between the
/// protocol core, radio backends, and ESPHome integration points.
 
/// @defgroup hioc_protocol Protocol Layer
/// @ingroup hioc_arch
/// @brief Frame definitions, crypto helpers, command builders, and protocol utilities.
 
/// @defgroup hioc_radio Radio Driver Layer
/// @ingroup hioc_arch
/// @brief Chip-specific radio abstractions and concrete SX1276/SX1262 drivers.
 
/// @defgroup hioc_hub Controller Layer
/// @ingroup hioc_arch
/// @brief Hub orchestration, exchange state machines, pairing, and runtime operations.
 
/// @defgroup hioc_entities ESPHome Integration Layer
/// @ingroup hioc_arch
/// @brief ESPHome-facing entity backends and YAML/code-generation modules.
 
/// @defgroup hioc_platforms Runtime Entities
/// @ingroup hioc_entities
/// @brief C++ entity implementations exposed to Home Assistant through ESPHome.
 
/// @defgroup hioc_codegen Python Code Generation
/// @ingroup hioc_entities
/// @brief ESPHome Python schema validation and code-generation modules.