Fix doxygen comments for hwtimer.h, queue.h and io.h #1041
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| void hwtimer_init(void); | ||
| void hwtimer_init_comp(uint32_t fcpu); |
There was a problem hiding this comment.
This function exists and is not static.
Sorry, you only moved the prototype.
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
Apr 22, 2014
addresses: RIOT-OS#1041 (comment)
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
Apr 22, 2014
addresses: RIOT-OS#1041 (diff)
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
Apr 22, 2014
addresses: RIOT-OS#1041 (comment)
| uint32_t priority; | ||
| struct queue_node_t *next; /**< next queue node */ | ||
| unsigned int data; /**< queue node data */ | ||
| uint32_t priority; /**< queue node priority */ |
There was a problem hiding this comment.
could you align above comments?
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
Apr 28, 2014
addresses RIOT-OS#1041 (comment)
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
Apr 28, 2014
addresses RIOT-OS#1041 (comment)
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
Apr 28, 2014
addresses RIOT-OS#1041 (comment) etc
| */ | ||
| void hwtimer_spin(unsigned long ticks); | ||
|
|
||
| int hwtimer_active(void); | ||
|
|
||
| /** @} */ |
There was a problem hiding this comment.
this file includes 2 closing @} but only one opening @{
| void queue_add_head(queue_node_t *root, queue_node_t *new_obj); | ||
|
|
||
| /** | ||
| * @brief remove the queues head |
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 13, 2014
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 13, 2014
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 13, 2014
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 13, 2014
addresses RIOT-OS#1041 (comment)
|
Anything else or shall I squash? |
| @@ -17,7 +17,7 @@ | |||
| * interrupt context and must use the shortest possible execution time (e.g. | |||
| * set a flag and trigger a worker thread). | |||
| * | |||
| * <b>The hardware timer must not be used within applications</b>, use \ref vtimer | |||
| * <b>The hardware timer must not be used within applications</b>, use \ref sys_vtimer | |||
There was a problem hiding this comment.
I think actually should not be used (until you know what you're doing) would be more accurate.
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 14, 2014
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 14, 2014
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 14, 2014
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 14, 2014
addresses RIOT-OS#1041 (comment)
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 14, 2014
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 14, 2014
LudwigKnuepfer
added a commit
to LudwigKnuepfer/RIOT
that referenced
this pull request
May 14, 2014
|
Everything addressed again, squash now? |
| @@ -22,6 +22,12 @@ | |||
| #ifndef IO_H | |||
| #define IO_H | |||
|
|
|||
| /** | |||
| * @brief Feuerwhere putstring implementation | |||
There was a problem hiding this comment.
Feuerware (Feuerwhere was only the name of the project) - or call it firmware_puts. ;)
|
One last comment from my side, otherwise I'm fine with squashing and merging. |
|
rebased, squashed |
|
has got one explicit and one implicit ACKs -> go |
LudwigKnuepfer
added a commit
that referenced
this pull request
May 15, 2014
Fix doxygen comments for hwtimer.h, queue.h and io.h
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some things struck me as strange and I added "@todo" comments to them. I'd propose to add tickets in their regard unless someone says here and now that everything is in order with the respective bits.Fixes #951