docs: Synchronize annotation and readme docs#279
Closed
boswelja wants to merge 1 commit intopdvrieze:masterfrom
Closed
docs: Synchronize annotation and readme docs#279boswelja wants to merge 1 commit intopdvrieze:masterfrom
boswelja wants to merge 1 commit intopdvrieze:masterfrom
Conversation
These were inconsistent in places. Some annotations had missing KDoc that was present in the README, some were missing in the README but had KDoc, and a few had inconsistent doc between both. I've gone through and reordered/rewritten the list, such that the README and KDoc are consistent with each other.
Owner
|
I've merged this (with further changes - also to synchronize with the already done documentation update work) into the dev branch. Thanks for your work ;-) |
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
2 participants
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.
These were inconsistent in places. Some annotations had missing KDoc that was present in the README, some were missing in the README but had KDoc, and a few had inconsistent doc between both. I've gone through and reordered/rewritten the list, such that the README and KDoc are consistent with each other.