fix: generate public API docs correctly#804
Open
zhjwpku wants to merge 2 commits into
Open
Conversation
Collaborator
Author
|
This patch resolves the following doc issues: 
|
manuzhang
reviewed
Jul 6, 2026
|
|
||
| #pragma once | ||
|
|
||
| /// \file iceberg/arrow/s3/s3_properties.h |
Member
There was a problem hiding this comment.
are these comments required for this fix?
Collaborator
Author
There was a problem hiding this comment.
I guess so. If not for this comment on the header files, the header would be listed but wouldn't be clickable， see https://cpp.iceberg.apache.org/api/files.html
manuzhang
suggested changes
Jul 7, 2026
manuzhang
left a comment
manuzhang
left a comment
Member
There was a problem hiding this comment.
The Doxygen config still scans implementation .cc files, so internal implementation helpers can remain in the public API docs.
Collaborator
Author
Good catch, I have changed |
manuzhang
approved these changes
Jul 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.