-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCS: fix doxygen not being generated for BLE classes #9906
Conversation
CI started |
Test run: FAILEDSummary: 3 of 9 test jobs failed Failed test jobs:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please define derived features such as BLE_FEATURE_ATT
and BLE_FEATURE_CONNECTABLE
.
Build failure due to: #9067 (comment) Not surprised, but taking note. |
CI started |
Test run: SUCCESSSummary: 13 of 13 test jobs passed |
I still can't find these classes in the Doxygen. |
@paul-szczepanek-arm please review |
they were produced by doxygen when run on my machine, maybe there's another failure reason on top of this one? |
Maybe I'm looking in the wrong place. Are they under Data Structures? |
I don't know how the website organises them but doxygen just produces a bunch of html files, including: |
I need to transclude (pull in with a special link) the rendered class .html files, If the pages don't exist, I can't pull them in. In the short term, I've linked to the .h files, but it's just a link that takes you to the Doxygen, instead of a transclusion that pulls in the Doxygen and shows it nicely rendered on the docs site. |
I don't know how to explain it - maybe those are old artifacts and the the script hasn't run on the new master? maybe the scripts run on the release branch? |
@SenRamakri Could someone from your team please help @paul-szczepanek-arm look into the Doxygen options for this? I think it's on the code end. |
Description
BLE is built conditionally based on compile time flags and doxygen needs to enable all the modules for the docs to be generated. This PR adds the macros to the doxyfile options.
Pull request type
Reviewers
@AnotherButler
Release Notes