docs(internal): correct Doxygen markup in header files

[hellobertrand]

Update Doxygen references and syntax to ensure consistent documentation generation and readability.

Summary by CodeRabbit

• Documentation
  • Clarified descriptions of frame information errors, frame-tail handling, and compression parameters.
  • Improved documentation for frame parsing, stream reading, and Huffman workspace parameters.
  • Corrected a documentation reference and updated the Meson Integration link.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 2ac15d93-5047-449f-9842-b2230adcafa1

---

📥 Commits

Reviewing files that changed from the base of the PR and between 062825f and 0eb0a38.

---

📒 Files selected for processing (7)

• docs/EXAMPLES.md
• src/lib/zxc_compress.c
• src/lib/zxc_dispatch.c
• src/lib/zxc_driver.c
• src/lib/zxc_huffman.c
• src/lib/zxc_internal.h
• src/lib/zxc_seekable.c

---

🚧 Files skipped from review as they are similar to previous changes (2)

• src/lib/zxc_internal.h
• src/lib/zxc_seekable.c

---

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.

---

---

📝 Walkthrough

Walkthrough

Source documentation comments were clarified, and the Meson Integration link was changed to an absolute GitHub URL. Declarations and runtime behavior are unchanged.

Changes

Documentation Clarifications

Layer / File(s)	Summary
Clarify source comments include/zxc_stream.h, src/lib/zxc_compress.c, src/lib/zxc_dispatch.c, src/lib/zxc_driver.c, src/lib/zxc_huffman.c, src/lib/zxc_internal.h, src/lib/zxc_seekable.c	Comments clarify parameter descriptions, documented error outcomes and conditions, and field descriptions. Declarations and behavior are unchanged.
Update documentation link docs/EXAMPLES.md	The Meson Integration link now points to the absolute GitHub URL for docs/INSTALL.md.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

---

Merge Risk: ⚪ Minimal · up to 0eb0a

The changes clarify source comments and update a documentation link; no actionable merge risk is evident in the supplied changes.

Pre-merge checks | 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title accurately identifies the documentation and Doxygen focus. The phrase "header files" is narrower than the changes, which also update source-file comments and a documentation link.
Docstring Coverage		Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 9 functions across 7 files. (1 skipped: 1 …
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

---

✨ Finishing Touches

📝 Generate docstrings

• Commit to this branch
• Create a new PR

---

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

---

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

---

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

• X
• Mastodon
• Reddit
• LinkedIn

---

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!