Skip to content

Ble doxy fixes #5701

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 5 commits into from
Dec 14, 2017
Merged

Ble doxy fixes #5701

merged 5 commits into from
Dec 14, 2017

Conversation

pan-
Copy link
Member

@pan- pan- commented Dec 13, 2017

Description

Remove warnings issued when the BLE documentation is generated by doxygen:

  • The tag @important has been replaced by @attention.
  • Typos in parameters name and doxygen commands have been fixed.
  • Internal headers are excluded from the generation process

Status

READY

Migrations

NO

@pan-
Copy link
Member Author

pan- commented Dec 13, 2017

@adbridge @AnotherButler Could you review this PR ? If it is accepted I suppose docs.json will have to be updated.

Copy link
Contributor

@adbridge adbridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAICT looks good to me

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 14, 2017

/morph build

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 14, 2017

All the CI was triggered, should be reported soon

@senthilr please review

@mbed-ci
Copy link

mbed-ci commented Dec 14, 2017

Build : SUCCESS

Build number : 702
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/5701/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build

doxyfile_options Outdated
*/features/FEATURE_COMMON_PAL/* \
*/features/FEATURE_LWIP/* \
*/features/FEATURE_UVISOR/* \
*/FEATURE_NANOSTACK/* \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no FEATURE_NANOSTACK, should be features/nanostack. Should we be excluding the following as well?

                     */features/filesystem/* \
                     */features/frameworks/* \
                     */features/netsocket/* \
                     */features/TESTS/* \

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pan- Will you be adding the above as well?

@pan-
Copy link
Member Author

pan- commented Dec 14, 2017

@SenRamakri Yes there is a FEATURE_NANOSTACK. I can change it into features/nanostack if you want.

@mbed-ci
Copy link

mbed-ci commented Dec 14, 2017

pan- added 2 commits December 14, 2017 16:44
* Remove BLE feature from the list of excluded folders.
* Define the macro MBED_DEPRECATED.
@pan-
Copy link
Member Author

pan- commented Dec 14, 2017

@SenRamakri done.

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 14, 2017

/morph build

Copy link
Contributor

@SenRamakri SenRamakri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now.

@mbed-ci
Copy link

mbed-ci commented Dec 14, 2017

Build : SUCCESS

Build number : 703
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/5701/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build

@mbed-ci
Copy link

mbed-ci commented Dec 14, 2017

@mbed-ci
Copy link

mbed-ci commented Dec 14, 2017

@adbridge adbridge merged commit 4d81ead into ARMmbed:master Dec 14, 2017
@pan- pan- deleted the ble-doxy-fixes branch July 3, 2018 11:04
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