Fix Doxygen errors #13255
Merged
Fix Doxygen errors #13255
Conversation
This file contains 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
pullapprove
bot
requested review from
anush-apple,
austinh0,
balducci-apple,
Byungjoo-Lee,
bzbarsky-apple,
carol-apple,
cecille,
chrisdecenzo,
chshu,
chulspro,
Damian-Nordic,
dhrishi,
electrocucaracha,
erjiaqing,
franck-apple,
gjc13,
harimau-qirex,
hawk248,
holbrookt,
jelderton,
jepenven-silabs,
jmartinez-silabs,
kghost,
LuDuda,
lzgrablic02,
mlepage-google,
msandstedt,
pan-apple and
robszewczyk
pullapprove
bot
requested review from
saurabhst,
selissia,
tecimovic,
vijs,
vivien-apple,
wbschiller,
woody-apple,
xylophone21 and
yufengwangca
saurabhst
approved these changes
Dec 28, 2021
|
PR #13255: Size comparison from 17520c3 to b158a92 Full report (11 builds for k32w, linux, p6, qpg, telink)
|
harsha-rajendran
force-pushed
the
fix-doxygen
branch
from
b158a92
to
87558ae
Compare
|
PR #13255: Size comparison from 17520c3 to 87558ae Full report (31 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
harsha-rajendran
force-pushed
the
fix-doxygen
branch
from
87558ae
to
75c4c42
Compare
|
PR #13255: Size comparison from a04c6d9 to 75c4c42 Full report (29 builds for efr32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
|
Re-enabling the "Doxygen workflow" for all PRs should prevent such issues from being introduced. Unless there's a different reason for disabling the Doxygen workflow that I am not aware of... :-) |
harsha-rajendran
force-pushed
the
fix-doxygen
branch
from
75c4c42
to
59d14aa
Compare
|
PR #13255: Size comparison from 99c1985 to 59d14aa Full report (31 builds for efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
|
electrocucaracha
approved these changes
Jan 3, 2022
There was a problem hiding this comment.
@woody-apple @andy31415 The size of this image has been reduced so maybe after merging this we can re-enable this workflow
|
@electrocucaracha - I believe the 'deploy doxygen' workflow was disabled because it created very large commits (maybe due to images? I am not sure) and there was no evidence that the doxygen output was actually used by anyone. |
andy31415
approved these changes
Jan 4, 2022
|
I would propose to enable the doxygen run to validate generation (i.e. make sure our comments are reasonably formatted) however without actually deploying just yet. There may be value in having one single 'doxygen' periodically, however one per merged PR seems not as useful. |
Another option is just run when a supported doxygen files are modified using GH paths |
step0035
pushed a commit
to hank820/connectedhomeip
that referenced
this pull request
Feb 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
Fixed Doxygen errors
Re-enabling the "Doxygen workflow" for all PRs should prevent such issues from being introduced. Unless there's a different reason for disabling the Doxygen workflow that I am not aware of... :-)
Change overview
Updated comments that were causing Doxygen generation from succeeding.
Testing
Tested by successfully generating Doxygen HTML docs on my local machine, i.e. the following commands now work.