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

Projects
None yet
7 participants
@paul-szczepanek-arm
Copy link
Member

commented Mar 1, 2019

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 approved these changes Mar 1, 2019

@cmonr cmonr added the needs: CI label Mar 1, 2019

@0xc0170

This comment has been minimized.

Copy link
Member

commented Mar 1, 2019

CI started

@mbed-ci

This comment has been minimized.

Copy link

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
@pan-
Copy link
Member

left a comment

Please define derived features such as BLE_FEATURE_ATT and BLE_FEATURE_CONNECTABLE .

@cmonr

This comment has been minimized.

Copy link
Contributor

commented Mar 1, 2019

Build failure due to: #9067 (comment)

Not surprised, but taking note.

@cmonr

This comment has been minimized.

Copy link
Contributor

commented Mar 1, 2019

CI started

@mbed-ci

This comment has been minimized.

Copy link

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

28 checks passed

continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jenkins-ci/build-ARMC5 Success
Details
jenkins-ci/build-ARMC6 Success
Details
jenkins-ci/build-GCC_ARM Success
Details
jenkins-ci/build-IAR8 Success
Details
jenkins-ci/cloud-client-test Success
Details
jenkins-ci/dynamic-memory-usage RTOS ROM(+0 bytes) RAM(+0 bytes)
Details
jenkins-ci/exporter Success
Details
jenkins-ci/greentea-test Success
Details
jenkins-ci/mbed2-build-ARMC5 Success
Details
jenkins-ci/mbed2-build-ARMC6 Success
Details
jenkins-ci/mbed2-build-GCC_ARM Success
Details
jenkins-ci/mbed2-build-IAR8 Success
Details
jenkins-ci/unittests Success
Details
travis-ci/astyle Local astyle testing has passed
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/doxy-spellcheck Local doxy-spellcheck testing has passed
Details
travis-ci/events Passed, runtime is 9977 cycles
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/include_check Local include_check testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8408B
Details
travis-ci/psa-autogen Local psa-autogen testing has passed
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details
travis-ci/tools-py3.5 Local tools-py3.5 testing has passed
Details
travis-ci/tools-py3.6 Local tools-py3.6 testing has passed
Details
travis-ci/tools-py3.7 Local tools-py3.7 testing has passed
Details

@cmonr cmonr removed the needs: CI label Mar 2, 2019

@AnotherButler

This comment has been minimized.

Copy link
Contributor

commented Mar 4, 2019

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

@0xc0170

This comment has been minimized.

Copy link
Member

commented Mar 4, 2019

@paul-szczepanek-arm please review

@paul-szczepanek-arm

This comment has been minimized.

Copy link
Member Author

commented Mar 4, 2019

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

@AnotherButler

This comment has been minimized.

Copy link
Contributor

commented Mar 4, 2019

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

@paul-szczepanek-arm

This comment has been minimized.

Copy link
Member Author

commented Mar 4, 2019

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

This comment has been minimized.

Copy link
Contributor

commented Mar 4, 2019

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

This comment has been minimized.

Copy link
Member Author

commented Mar 4, 2019

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

This comment has been minimized.

Copy link
Contributor

commented Mar 5, 2019

@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
You can’t perform that action at this time.