Add generated docs check and generated headers target, and remove FIREBASE_NAMESPACE macro. #499
Conversation
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
(required removing FIREBASE_NAMESPACE.)
jonsimantov
requested review from
a-maurice and
alexames
and removed request for
alexames and
a-maurice
jonsimantov
added
the
tests-requested: quick
github-actions
bot
added
tests: in-progress
✅ Integration test succeeded!Requested by @jonsimantov on commit b0a9062 |
jonsimantov
added
the
tests-requested: quick
github-actions
bot
removed
the
tests-requested: quick
jonsimantov
changed the title
github-actions
bot
added
the
tests: succeeded
firebase-workflow-trigger
bot
removed
the
tests: in-progress
alexames
approved these changes
Jun 30, 2021
github-actions
bot
added
tests: in-progress
github-actions
bot
added
the
tests: succeeded
firebase-workflow-trigger
bot
removed
the
tests: in-progress
jonsimantov
added a commit
that referenced
this pull request
Jul 1, 2021
…EBASE_NAMESPACE macro. (#499) Run Doxygen as part of the common PR checks. This will fail if Doxygen returns any errors or warnings. This could include missing or misspelled parameters, missing method documentation, or other issues. Because we don't perform a full header scrub here, the Doxygen config file uses _sed_ to remove everything between `<SWIG>` and `</SWIG>`. We could potentially perform a second pass with SWIG enabled, or do this in the Unity repo in the future, to check C# documentation. This PR also fixes some of those same issues present in our build right now, including a few missing method docs in Firestore, a missing parameter in Database, and bad cross-references in a few different places, including all references to App and Future, which were failing due to the FIREBASE_NAMESPACE macro which is no longer needed. _This PR removes all usages of the FIREBASE_NAMESPACE macro._ Note that because we also run Doxygen on some generated headers, this PR includes a new CMake target to build those headers without building the entire build. Any future generated headers should be added to that target. This PR also contains a small change to print the list of files requiring code formatting directly to the GitHub workflow log.
jonsimantov
commented
Jul 2, 2021
|
|
||
| namespace firebase { | ||
| namespace internal { | ||
| class VariantInternal; | ||
| } | ||
| } // namespace firebase | ||
|
|
||
| namespace FIREBASE_NAMESPACE { | ||
| namespace firebase { |
There was a problem hiding this comment.
This is a test comment.
jonsimantov
commented
Jul 2, 2021
| } \ | ||
| classname& operator=(firebase::internal::JObjectReference&& rhs) { \ | ||
| firebase::internal::JObjectReference::operator=(rhs); \ | ||
| return *this; \ |
There was a problem hiding this comment.
This is a second comment.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Run Doxygen as part of the common PR checks.
This will fail if Doxygen returns any errors or warnings. This could include missing or misspelled parameters, missing method documentation, or other issues.
Because we don't perform a full header scrub here, the Doxygen config file uses sed to remove everything between
<SWIG>and</SWIG>. We could potentially perform a second pass with SWIG enabled, or do this in the Unity repo in the future, to check C# documentation.This PR also fixes some of those same issues present in our build right now, including a few missing method docs in Firestore, a missing parameter in Database, and bad cross-references in a few different places, including all references to App and Future, which were failing due to the FIREBASE_NAMESPACE macro which is no longer needed. This PR removes all usages of the FIREBASE_NAMESPACE macro.
Note that because we also run Doxygen on some generated headers, this PR includes a new CMake target to build those headers without building the entire build. Any future generated headers should be added to that target.
This PR also contains a small change to print the list of files requiring code formatting directly to the GitHub workflow log.