Add documentation for Cxx API snapshot generation#56146
Closed
coado wants to merge 1 commit intofacebook:mainfrom
Closed
Add documentation for Cxx API snapshot generation#56146coado wants to merge 1 commit intofacebook:mainfrom
coado wants to merge 1 commit intofacebook:mainfrom
Conversation
Summary: Adds documentation for the cxx-api snapshot generation pipeline, covering usage commands for generating and checking snapshots, and configuration. It answers: 1. What the script does. 2. What the output looks like. 3. How to use it (generate, check). 4. How it works (Doxygen → parser → .api files). 5. How it can be configured (config.yml). 6. What to do when snapshots differ. Changelog: [Internal] Reviewed By: huntie Differential Revision: D96316004
meta-cla
bot
added
the
CLA Signed
facebook-github-tools
bot
added
p: Software Mansion
|
This pull request has been merged in 25ef844. |
Collaborator
|
This pull request was successfully merged by @coado in 25ef844 When will my fix make it into a release? | How to file a pick request? |
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.
Summary:
Adds documentation for the cxx-api snapshot generation pipeline, covering usage commands for generating and checking snapshots, and configuration.
It answers:
Changelog:
[Internal]
Reviewed By: huntie
Differential Revision: D96316004