Skip to content

Fix gtk-doc warnings for docstrings and sections file#1194

Merged
vojtechtrefny merged 1 commit intostoraged-project:masterfrom
vojtechtrefny:master_docs-fixes
Apr 24, 2026
Merged

Fix gtk-doc warnings for docstrings and sections file#1194
vojtechtrefny merged 1 commit intostoraged-project:masterfrom
vojtechtrefny:master_docs-fixes

Conversation

@vojtechtrefny
Copy link
Copy Markdown
Member

@vojtechtrefny vojtechtrefny commented Apr 23, 2026

  • 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

Summary by CodeRabbit

  • API Changes

    • Removed public symbols from partition and SMART modules
  • Documentation

    • Enhanced parameter documentation across file system storage plugins with improved nullability annotations and descriptions

- 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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 23, 2026

📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
Symbol Export Cleanup
docs/libblockdev-sections.txt
Removed 4 exported symbols: BD_PART_TYPE_SPEC, bd_part_spec_get_type from part module; BD_SMART_TYPE_ATA, BD_SMART_TYPE_ATA_ATTRIBUTE from smart module.
Btrfs Plugin Documentation
src/plugins/btrfs.c
Removed @extra parameter description from bd_btrfs_change_label Doxygen comment.
Filesystem Info Functions
src/plugins/fs/btrfs.c, exfat.c, ext.c, f2fs.c, nilfs.c, ntfs.c, udf.c, vfat.c, xfs.c
Updated Doxygen/GIR annotations for *_info_copy and *_info_free functions across all filesystem plugins to explicitly mark data parameters as nullable and specify corresponding type descriptors.
Device Plugin Documentation
src/plugins/mdraid.c, nvdimm.c, s390.c
Added/updated GLib-doc annotations: mdraid added nullable annotations for copy/free helpers and reformatted bd_md_get_status header; nvdimm corrected parameter names in documentation (bus_namebus, region_nameregion); s390 reformatted Doxygen comment header for bd_s390_zfcp_scsi_offline.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: fixing gtk-doc warnings by updating docstrings and the sections file.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 81c7a4b and cf9ca5f.

📒 Files selected for processing (14)
  • docs/libblockdev-sections.txt
  • src/plugins/btrfs.c
  • src/plugins/fs/btrfs.c
  • src/plugins/fs/exfat.c
  • src/plugins/fs/ext.c
  • src/plugins/fs/f2fs.c
  • src/plugins/fs/nilfs.c
  • src/plugins/fs/ntfs.c
  • src/plugins/fs/udf.c
  • src/plugins/fs/vfat.c
  • src/plugins/fs/xfs.c
  • src/plugins/mdraid.c
  • src/plugins/nvdimm.c
  • src/plugins/s390.c
💤 Files with no reviewable changes (2)
  • src/plugins/btrfs.c
  • docs/libblockdev-sections.txt

Comment thread src/plugins/nvdimm.c
@vojtechtrefny vojtechtrefny merged commit 73064a0 into storaged-project:master Apr 24, 2026
49 of 50 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants