Skip to content

usbcdc: provide doxygen only macro for doxy builder #12913

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

Merged
merged 1 commit into from
May 4, 2020

Conversation

0xc0170
Copy link
Contributor

@0xc0170 0xc0170 commented May 4, 2020

Summary of changes

There is functionality hidden behind this macro. As result, doxygen won't include these. It should be
enabled to cover this functionality as well.

Impact of changes

Migration actions required

Documentation


Pull request type

[x] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results

[x] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers


@iriark01 @ARMmbed/mbed-os-core

@0xc0170
Copy link
Contributor Author

0xc0170 commented May 4, 2020

The predefined contain only drivers but there is BLE and TFM. My question is what should be in predefined? As I believe we are missing there much more?

Wait a sec, there is also json file - I am confused...

@0xc0170
Copy link
Contributor Author

0xc0170 commented May 4, 2020

Updated also json file

@ciarmcom
Copy link
Member

ciarmcom commented May 4, 2020

@0xc0170, thank you for your changes.
@iriark01 @ARMmbed/mbed-os-maintainers please review.

@0xc0170 0xc0170 requested a review from a team May 4, 2020 09:01
@0xc0170
Copy link
Contributor Author

0xc0170 commented May 4, 2020

Still failing, not fixed the issue: requests.exceptions.HTTPError: 404 Client Error: Not Found for url: https://os.mbed.com/docs/mbed-os/6.0.0-preview/mbed-os-api-doxy/class_u_s_b_c_d_c___e_c_m.html

@0xc0170 0xc0170 force-pushed the doxygen_rtos_fix branch from 0de2384 to 57b6df9 Compare May 4, 2020 11:11
@0xc0170 0xc0170 changed the title doxygen: Add RTOS present macro usbcdc: provide doxygen only macro for doxy builder May 4, 2020
@0xc0170
Copy link
Contributor Author

0xc0170 commented May 4, 2020

I updated the branch - force pushed to provide another way to get doxygen . Before I go down the rabbit hole to touch doxygen_options, we should try to use || defined(DOXYGEN_ONLY) that is already being used.

@0xc0170
Copy link
Contributor Author

0xc0170 commented May 4, 2020

tested locally by running doxygen. Without a fix file mbed-os/BUILD/html/class_u_s_b_c_d_c___e_c_m.html is not generated - no doxygen for this object. With this PR, it is generated as previously was (5.15 contains this class documented).

@0xc0170
Copy link
Contributor Author

0xc0170 commented May 4, 2020

CI started

Please review, if we can merge this asap to master to fix building the docs for 6.0.0beta1

@mbed-ci
Copy link

mbed-ci commented May 4, 2020

Test run: SUCCESS

Summary: 6 of 6 test jobs passed
Build number : 1
Build artifacts

@0xc0170
Copy link
Contributor Author

0xc0170 commented May 4, 2020

Needs a review and should be good to go in.

@0xc0170 0xc0170 merged commit 918d679 into ARMmbed:master May 4, 2020
@mergify mergify bot removed the ready for merge label May 4, 2020
@0xc0170 0xc0170 deleted the doxygen_rtos_fix branch May 4, 2020 14:15
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.

5 participants