Open
Conversation
It shouldn't change any real behaviour: the compiler can infer that the pointer is non-NULL in all cases. Documenting that we do this is a good plan anyway.
dkfellows
added
bug
minor
dkfellows
commented
Aug 12, 2020
| // Load timing dependence data | ||
| address_t weight_region_address = timing_initialise(address); | ||
| if (address == NULL) { | ||
| if (weight_region_address == NULL) { |
Member
Author
There was a problem hiding this comment.
This change was an absolute howler. Fortunately, I think the compiler was proving in all cases that the branch couldn't be taken, but it's still absurd.
dkfellows
commented
Aug 17, 2020
| # The default value is: NO. | ||
|
|
||
| SOURCE_BROWSER = NO | ||
| SOURCE_BROWSER = YES |
Member
Author
There was a problem hiding this comment.
Generates a link to the (pretty-printed) source for all files, not just headers.
dkfellows
commented
Aug 17, 2020
| //! \param[in] s: the spike to get the key from | ||
| //! \return key_t: the key from the spike | ||
| //! \return the key from the spike | ||
| static inline key_t spike_key(spike_t s) { |
Member
Author
There was a problem hiding this comment.
The key change I'm doing here is I'm trying to make it so that spike_key and spike_payload are only defined once; the differences are in the types they talk about and the body of the function. This makes the documentation process much nicer.
dkfellows
commented
Aug 17, 2020
| * spike is compiled as not having a pay load, the pay load will always be | ||
| * returned as 0 | ||
| */ | ||
| #ifndef __SPIKE_T__ |
Member
Author
There was a problem hiding this comment.
Don't need this. The file already has a guard and only this file defines the type of spikes.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Miscellaneous bits extracted from #857, mostly documentation tweaking to ensure that we always use the same active verb tense for brief descriptions of C functions.