Skip to content
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

Merged
merged 1 commit into from
Mar 2, 2019

Conversation

paul-szczepanek-arm
Copy link
Member

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

[x] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@AnotherButler

Release Notes

@cmonr cmonr added the needs: CI label Mar 1, 2019
@0xc0170
Copy link
Contributor

0xc0170 commented Mar 1, 2019

CI started

@mbed-ci
Copy link

mbed-ci commented Mar 1, 2019

Test run: FAILED

Summary: 3 of 9 test jobs failed
Build number : 1
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_build-GCC_ARM
  • jenkins-ci/mbed-os-ci_build-IAR8
  • jenkins-ci/mbed-os-ci_build-ARMC5

Copy link
Member

@pan- pan- left a 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 .

@cmonr
Copy link
Contributor

cmonr commented Mar 1, 2019

Build failure due to: #9067 (comment)

Not surprised, but taking note.

@cmonr
Copy link
Contributor

cmonr commented Mar 1, 2019

CI started

@mbed-ci
Copy link

mbed-ci commented Mar 2, 2019

Test run: SUCCESS

Summary: 13 of 13 test jobs passed
Build number : 2
Build artifacts

@cmonr cmonr merged commit ca06f94 into ARMmbed:master Mar 2, 2019
@cmonr cmonr removed the needs: CI label Mar 2, 2019
@AnotherButler
Copy link
Contributor

I still can't find these classes in the Doxygen.

@0xc0170
Copy link
Contributor

0xc0170 commented Mar 4, 2019

@paul-szczepanek-arm please review

@paul-szczepanek-arm
Copy link
Member Author

they were produced by doxygen when run on my machine, maybe there's another failure reason on top of this one?

@AnotherButler
Copy link
Contributor

Maybe I'm looking in the wrong place. Are they under Data Structures?

@paul-szczepanek-arm
Copy link
Member Author

I don't know how the website organises them but doxygen just produces a bunch of html files, including:
class_battery_service.html
which is what you were after, right?

@AnotherButler
Copy link
Contributor

I need to transclude (pull in with a special link) the rendered class .html files,
but I can't find them anywhere on the site: https://os.mbed.com/docs/mbed-os/development/mbed-os-api-doxy/annotated.html

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.

@paul-szczepanek-arm
Copy link
Member Author

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?

@AnotherButler
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants