Skip to content

Change enet_tasklet declarations to match code #9034

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Dec 12, 2018
Merged

Change enet_tasklet declarations to match code #9034

merged 2 commits into from
Dec 12, 2018

Conversation

KariHaapalehto
Copy link
Contributor

Description

Modify enet_tasklet.h.
Change enet_tasklet_network_init() and enet_tasklet_disconnect()
declarations to match code. Also add document enet_tasklet.h functions

Pull request type

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

@KariHaapalehto
Modify enet_tasklet.h
7e7af77 
Change enet_tasklet_network_init() and enet_tasklet_disconnect()
declarations to match code. Also add document enet_tasklet.h functions
kjbracey
kjbracey reviewed Dec 10, 2018
View reviewed changes
features/nanostack/mbed-mesh-api/source/include/enet_tasklet.h
void enet_tasklet_init(void);
uint8_t enet_tasklet_network_init(int8_t);

/*
Copy link
Contributor

Choose a reason for hiding this comment

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

These don't have the correct /** Doxygen markers - but if you do add them, do also add \internal commands, as I nothing here is public API .

Copy link
Contributor

Choose a reason for hiding this comment

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

(Actually, you can probably put some sort of big group marker that says the whole thing is internal. Not sure of exact syntax)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually the other tasklet header files(thread_tasklet.h, nd_tasklet.h etc) are documented same way than enet_tasklet now

Copy link
Contributor

@0xc0170 0xc0170 Dec 11, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Looks like a new tracking issue to use doxygen but having it internal (we can keep it here as it is if its used in this module for now).

@ciarmcom ciarmcom requested review from a team December 10, 2018 16:00
@ciarmcom
Copy link
Member

@KariHaapalehto, thank you for your changes.
@ARMmbed/mbed-os-ipcore @ARMmbed/mbed-os-maintainers please review.

@0xc0170 0xc0170 requested a review from melwee01 December 11, 2018 15:47
@0xc0170
Copy link
Contributor

0xc0170 commented Dec 11, 2018

@melwee01 Please review

melwee01
melwee01 reviewed Dec 12, 2018
View reviewed changes
melwee01
melwee01 approved these changes Dec 12, 2018
View reviewed changes
Copy link
Contributor

@melwee01 melwee01 left a comment

Choose a reason for hiding this comment

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

Address doxy format issues that kjbracey raised, and I think we're good.

kjbracey
kjbracey approved these changes Dec 12, 2018
View reviewed changes
Copy link
Contributor

@kjbracey kjbracey left a comment

Choose a reason for hiding this comment

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

I'm fine with leaving this as-is - "looks like Doxygen, but isn't due to lack of markers", if that's what the rest of the files in that directory are doing. It's not public API, so shouldn't be appearing anywhere anyway.

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 12, 2018

CI started

@mbed-ci
Copy link

mbed-ci commented Dec 12, 2018

Test run: FAILED

Summary: 1 of 11 test jobs failed
Build number : 1
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_greentea-test

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 12, 2018

2 failures, they are new but not related to this changeset, will restart

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 12, 2018

Test restarted

@cmonr cmonr merged commit d53553e into ARMmbed:master Dec 12, 2018
@KariHaapalehto KariHaapalehto deleted the enet_tasklet_definitions branch December 14, 2018 06:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@melwee01 melwee01 melwee01 approved these changes

@0xc0170 0xc0170 0xc0170 approved these changes

@SeppoTakalo SeppoTakalo SeppoTakalo approved these changes

@kjbracey kjbracey kjbracey approved these changes

Assignees
No one assigned
Labels
release-version: 5.11.1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@KariHaapalehto @ciarmcom @0xc0170 @mbed-ci @SeppoTakalo @kjbracey @melwee01 @cmonr