-
Notifications
You must be signed in to change notification settings - Fork 116
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
Conversation
@@ -1,16 +1,16 @@ | |||
/* | |||
* Author: ACRE2Team | |||
* SHORT DESCRIPTION | |||
* Return function for signal calculation. Will be called after signal has been calculated in extension |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"_radioID1", "_radioID2"
-> _radioID1, _radioID2
There was a problem hiding this comment.
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.
Deleted the example and corrected the wording on return-function |
There was a problem hiding this 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> | ||
* - |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Final dot too.
sys_signal of #107