Fix gtk-doc warnings for docstrings and sections file#1194
Fix gtk-doc warnings for docstrings and sections file#1194vojtechtrefny merged 1 commit intostoraged-project:masterfrom
Conversation
- Remove stale @extra parameter from bd_btrfs_change_label docstring - Fix parameter names in bd_nvdimm_list_namespaces to match public API - Add missing colon in bd_s390_zfcp_scsi_offline and bd_md_get_status - Add missing @DaTa parameter docs to all info copy/free functions - Remove undeclared GType symbols from libblockdev-sections.txt Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
📝 WalkthroughWalkthroughThis pull request updates documentation across multiple plugin modules by removing obsolete symbol exports and improving Doxygen/GIR annotations for public API functions, particularly clarifying nullable parameters in copy/free helper functions across filesystem and device management plugins. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/plugins/nvdimm.c`:
- Around line 521-524: The docblock parameter names `@bus` and `@region` don't match
the function parameter identifiers bus_name and region_name; update the docblock
to use `@bus_name` and `@region_name` (or alternatively rename the function
parameters to bus and region) so the tag names exactly match the C function
signature (look for the function with parameters bus_name and region_name in
src/plugins/nvdimm.c) and remove gtk-doc parameter-name warnings.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 945bcc0c-5596-4961-80a5-9827152647be
📒 Files selected for processing (14)
docs/libblockdev-sections.txtsrc/plugins/btrfs.csrc/plugins/fs/btrfs.csrc/plugins/fs/exfat.csrc/plugins/fs/ext.csrc/plugins/fs/f2fs.csrc/plugins/fs/nilfs.csrc/plugins/fs/ntfs.csrc/plugins/fs/udf.csrc/plugins/fs/vfat.csrc/plugins/fs/xfs.csrc/plugins/mdraid.csrc/plugins/nvdimm.csrc/plugins/s390.c
💤 Files with no reviewable changes (2)
- src/plugins/btrfs.c
- docs/libblockdev-sections.txt
73064a0
into
storaged-project:master
@extraparameter from bd_btrfs_change_label docstring@dataparameter docs to all info copy/free functionsSummary by CodeRabbit
API Changes
Documentation