Commenting C and Python Files

This skill describes the commenting conventions used across the bocpy project. Follow these patterns when adding or editing comments so the codebase stays consistent.

C Files (_core.c, _math.c)

Function-Level Documentation — Doxygen /// Style

Every non-trivial function gets a Doxygen doc-comment block immediately above its signature. Use triple-slash /// lines with @ tags in this order:

1. @brief — one-line summary (sentence case, no trailing period)
2. @details — optional longer explanation
3. @note — optional caveats or side-effects
4. @param — one per parameter (description starts uppercase)
5. @return — what the function returns