Issue 11834: std.net.curl abuses ddoc params section and causes ddoc warnings #2427
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
added 3 commits
August 14, 2014 19:10
Refactor callback params as macro to minimize copy-n-paste.
WalterBright
added a commit
that referenced
this pull request
Aug 16, 2014
Issue 11834: std.net.curl abuses ddoc params section and causes ddoc warnings
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.
Fixes: https://issues.dlang.org/show_bug.cgi?id=11834
Basically, the
Params:section inonProgress's ddoc was abused to document parameters that will be passed to the callback registered byonProgress. This confuses ddoc to spew warning messages, and also produces deceptive documentation that looks like those parameters are being passed toonProgress, whereas they are actually what will be passed byonProgresstocallback.