|SUCCESS| raw/cnxk_bphy: fix missing doxygen comments
dpdklab at iol.unh.edu
dpdklab at iol.unh.edu
Fri Aug 7 12:52:15 CEST 2026
Test-Label: ai-code-review
Test-Status: SUCCESS
https://dpdk.org/patch/167368
_AI Code Review_
=== Patch Review: series.patch (via Claude) ===
Review date: 2026-08-07
# DPDK Patch Review
## Summary
This patch adds Doxygen comments for two enums in the cnxk_bphy raw driver and enables API documentation generation for this driver. The changes are minimal and focused on fixing documentation build failures.
---
## Findings
### **Errors**
None.
---
### **Warnings**
None.
---
### **Info**
1. **Incomplete enum documentation**
The patch adds high-level comments for two enums but does not document individual enum values. For complete API documentation, consider adding comments for each enum member, especially for `enum cnxk_bphy_cgx_eth_mode_cpri` where the bit rate values would benefit from explanation.
Example:
```c
/** Available CPRI modes */
enum cnxk_bphy_cgx_eth_mode_cpri {
/** 2.4G Lane Rate */
CNXK_BPHY_CGX_ETH_MODE_CPRI_2_4G_BIT,
/** 3.1G Lane Rate */
CNXK_BPHY_CGX_ETH_MODE_CPRI_3_1G_BIT,
/* ... etc ... */
};
```
This is informational only since the existing enum member comments appear to be sufficient for understanding the values.
2. **Enum `cnxk_bphy_cgx_eth_link_mode` undocumented**
The enum `cnxk_bphy_cgx_eth_link_mode` appears in the same header file but receives no documentation comment in this patch. While not required to fix the immediate build failure, it would be worth documenting for completeness since the header is now part of the API documentation.
---
## Conclusion
The patch is correct and achieves its stated goal of fixing the documentation build for the cnxk_bphy raw driver. The changes are minimal, appropriate for a documentation fix, and properly tagged for stable backport.
The Info-level suggestions above are for completeness but are not blockers for merging this patch.
More information about the test-report
mailing list