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

Eventqueue Templatewall Doxygen Rework #7810

Merged
merged 5 commits into from Aug 24, 2018

Conversation

Projects
None yet
7 participants
@kegilbert
Contributor

kegilbert commented Aug 16, 2018

Description

The doxygen for the EventQueue API (and Callback class but that's not covered in this PR) are illegible due to how the classes are implemented/doxygen-ified before. Chris and Vincent set up this solution a while back, just implementing the rest of their work: #7303

Additionally added some inline examples on how to setup/call the different overloaded methods in EventQueue. NOTE: Will squash the commit history following any feedback

Before

image

After

image


Example of expanded function doc

image

@geky Lot of copy and pasting, so may have borked one of the comment headers or examples in the new vararg function declarations.
@AnotherButler

Feel free to add anyone else to the review.

Pull request type

[ ] Fix
[X] Refactor
[ ] Target update
[ ] Functionality change
[ ] Breaking change

kegilbert added some commits Aug 7, 2018

Patch EventQueue doxygen to remove templatewall
In the doxygen only segment define generic function declarations for the docs

Finished initial rework, pending TODOs for param comments

@kegilbert kegilbert requested review from geky and pan- Aug 16, 2018

@cmonr cmonr added the needs: review label Aug 17, 2018

@pan-

That looks promising.

I think it would be valuable to document the template types requirements with the tag @tparam.

Any change we got the same update for the Event and Callback classes ?

@kegilbert

This comment has been minimized.

Contributor

kegilbert commented Aug 17, 2018

@pan- I was thinking about adding the tparam blocks, can definitely put them back in. After that update if this looks good I'd like to do the same to the Callback class.

@geky

geky approved these changes Aug 17, 2018

Nice! 👍

The documentation looks great and I like the added examples for each function.

@0xc0170 0xc0170 requested a review from AnotherButler Aug 20, 2018

Copy edit EventQueue.h
Copy edit file for consistent capitalization, tense and voice.
@0xc0170

This comment has been minimized.

Member

0xc0170 commented Aug 22, 2018

/morph build

@mbed-ci

This comment has been minimized.

mbed-ci commented Aug 22, 2018

Build : SUCCESS

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

Triggering tests

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

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Aug 22, 2018

/morph mbed2-build

@mbed-ci

This comment has been minimized.

@mbed-ci

This comment has been minimized.

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 23, 2018

/morph export-build

@mbed-ci

This comment has been minimized.

@cmonr

This comment has been minimized.

Contributor

cmonr commented Aug 23, 2018

Wow. An eclipse runtime error.
At least that's a new one.

/morph export-build

@mbed-ci

This comment has been minimized.

@0xc0170 0xc0170 merged commit 05b2d6e into ARMmbed:master Aug 24, 2018

15 checks passed

AWS-CI uVisor Build & Test Success
Details
ci-morph-build build completed
Details
ci-morph-exporter build completed
Details
ci-morph-mbed2-build build completed
Details
ci-morph-test test completed , RTOS ROM(+0.0%) RAM(+0.0%)
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jenkins-ci/cloud_client_smoke_test Test job was successful
Details
travis-ci/astyle Passed, 585 files
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 9967 cycles (-235 cycles)
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8372B (+0.00%)
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details

pan- pushed a commit to pan-/mbed that referenced this pull request Aug 29, 2018

Merge pull request ARMmbed#7810 from kegilbert/eventqueue-templatewal…
…l-rework

Eventqueue Templatewall Doxygen Rework
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment