Skip to content

fix: generate public API docs correctly#804

Merged
wgtmac merged 2 commits into
apache:mainfrom
zhjwpku:docs-exclude-internal-api
Jul 11, 2026
Merged

fix: generate public API docs correctly#804
wgtmac merged 2 commits into
apache:mainfrom
zhjwpku:docs-exclude-internal-api

Conversation

@zhjwpku

@zhjwpku zhjwpku commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@zhjwpku

zhjwpku commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator Author

This patch resolves the following doc issues:

image image


#pragma once

/// \file iceberg/arrow/s3/s3_properties.h

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

are these comments required for this fix?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

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 manuzhang left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The Doxygen config still scans implementation .cc files, so internal implementation helpers can remain in the public API docs.

@zhjwpku

zhjwpku commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator Author

The Doxygen config still scans implementation .cc files, so internal implementation helpers can remain in the public API docs.

Good catch, I have changed FILE_PATTERNS to include only *.h *.md *.dox, hope this works.

@zhjwpku zhjwpku added the ready to merge This PR has been approved and it is ready to merge. label Jul 9, 2026
@wgtmac wgtmac removed the ready to merge This PR has been approved and it is ready to merge. label Jul 11, 2026
@wgtmac

wgtmac commented Jul 11, 2026

Copy link
Copy Markdown
Member

Nice! Thanks @zhjwpku for fixing this and @manuzhang for the careful review!

@wgtmac wgtmac merged commit b4737df into apache:main Jul 11, 2026
21 checks passed
@zhjwpku zhjwpku deleted the docs-exclude-internal-api branch July 11, 2026 11:55
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.

3 participants