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

Documentation -- Function Headers -- sys_signal #111

Merged
merged 3 commits into from
Dec 12, 2016

Conversation

Soldia1138
Copy link
Member

sys_signal of #107

@jonpas jonpas added this to the 2.3.0 milestone Nov 29, 2016
@@ -1,16 +1,16 @@
/*
* Author: ACRE2Team
* SHORT DESCRIPTION
* Return function for signal calculation. Will be called after signal has been calculated in extension
Copy link
Member

Choose a reason for hiding this comment

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

in the extension

*
* Example:
* [ARGUMENTS] call acre_COMPONENT_fnc_FUNCTIONNAME
* [FREQUENCY, POWER, "_radioID1", "_radioID2"] call acre_sys_signal_fnc_getSignal
Copy link
Member

Choose a reason for hiding this comment

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

"_radioID1", "_radioID2" -> _radioID1, _radioID2

Copy link
Member

Choose a reason for hiding this comment

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

Preferably those examples should have an example of direct data input.

@Soldia1138
Copy link
Member Author

Soldia1138 commented Nov 29, 2016

Deleted the example and corrected the wording on return-function

Copy link
Member

@Sniperhid Sniperhid left a comment

Choose a reason for hiding this comment

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

LGTM

*
* Return Value:
* RETURN VALUE <TYPE>
* -
Copy link
Member

Choose a reason for hiding this comment

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

None

@@ -1,16 +1,14 @@
/*
* Author: ACRE2Team
* SHORT DESCRIPTION
* Return function for signal calculation. Will be called after signal has been calculated in the extension
Copy link
Member

Choose a reason for hiding this comment

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

Should be dot at the end, so it'll look nice when we generate the functions list (this one won't be there, but still, consistency).

@@ -1,22 +1,24 @@
/*
* Author: ACRE2Team
* SHORT DESCRIPTION
* Wrapper function for calling the signal calculation (extension)
Copy link
Member

Choose a reason for hiding this comment

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

Final dot too.

@jonpas jonpas modified the milestones: 2.3.0, 2.4.0 Dec 1, 2016
@Soldia1138 Soldia1138 merged commit 305eafd into master Dec 12, 2016
@Soldia1138 Soldia1138 deleted the functionHeadersSignal branch December 12, 2016 06:03
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.

None yet

3 participants