Skip to content

Document client options #613

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

Merged
merged 5 commits into from
Mar 8, 2016

Conversation

deanberris
Copy link
Member

This makes the documentation in the code the canonical documentation.

This allows us to use the doxygen docs as the canonical documentation
for the HTTP Client API. This removes a lot of the hand-written and
outdated documentation, and have documentation near the code instead.
client_options& io_service(std::shared_ptr<asio::io_service> v) {
io_service_ = v;
return *this;
}

/// Set whether we always verify the peer on the other side of the HTTPS
/// connection.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could use a:

/// Default: true

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done -- and now changed the default to actually true (!!!?).

@deanberris
Copy link
Member Author

Okay, Travis is green now. Merging it.

deanberris added a commit that referenced this pull request Mar 8, 2016
@deanberris deanberris merged commit 620a0c5 into cpp-netlib:master Mar 8, 2016
@deanberris deanberris deleted the document-client-options branch March 8, 2016 04:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants