This repository was archived by the owner on Apr 16, 2018. It is now read-only.
Try to add documentation in socket.hpp #4
Merged
Conversation
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
agauniyal
suggested changes
Feb 23, 2017
include/socket.hpp
Outdated
| * @param {callable} _fn Some callable that writes using socket descriptor. | ||
| * @param {int} _sockfd Descriptor representing a socket. | ||
| * @param {string} _msg Msg to write on _sockfd. | ||
| * @param {_______} args Flags, destination sockaddr objects and their lengths. !!Improve This!! |
include/socket.hpp
Outdated
| * @param {callable} _fn Some callable that reads using socket descriptor. | ||
| * @param {int} _sockfd Descriptor representing a socket. | ||
| * @param {string} _str String to store the data. | ||
| * @param {_______} args Flags, destination sockaddr objects and their lengths. !!Improve This!! |
| @@ -9,6 +9,11 @@ | |||
|
|
|||
| namespace net { | |||
There was a problem hiding this comment.
Please format with clang-format.
include/socket.hpp
Outdated
| void connect(const char[], const int = 0, bool * = nullptr); | ||
|
|
||
| /** @method connect | ||
| * @access public | ||
| * Connects net::Socket to _______ if successful else throws runtime_error exception. !!Improve This!! |
include/socket.hpp
Outdated
|
|
||
| /** @method connect | ||
| * @access public | ||
| * Connects net::Socket to _______ if successful else throws runtime_error exception. !!Improve This!! |
include/socket.hpp
Outdated
|
|
||
| /** @method connect | ||
| * @access public | ||
| * Connects net::Socket to _______ if successful else throws runtime_error exception. !!Improve This!! |
include/socket.hpp
Outdated
| * Shutdown Socket using net::SF::shut. | ||
| * | ||
| * @param {net::SF::shut} s Option specifying which side of connection to shutdown for Socket. | ||
| */ | ||
| void stop(SF::shut s) const noexcept |
There was a problem hiding this comment.
Please make it _s instead of s both in documentation and function definition.
include/socket.hpp
Outdated
| * Set a socket option from net::SF::opt for Socket using object of type net::SF::sockOpt. | ||
| * | ||
| * @param {net::SF::opt} _opType Option to set for Socket. | ||
| * @param {net::SF::sockOpt} _opValue ___________ !!Improve This!!. |
There was a problem hiding this comment.
___________ = socket option structure. Present inside socket_family.hpp
agauniyal
changed the base branch from
feature/socket-options
to
feature/socket
|
The commit msg was actually: Add clang formatted doc and remove all !!Improve This!! from doc |
|
@tkhurana96 Since no one else is working on your branch, execute this - and then execute - |
tkhurana96
force-pushed
the
documentation
branch
from
97e2044 to
433a7dd
Compare
|
@tkhurana96 there is |
tkhurana96
force-pushed
the
documentation
branch
from
5c89207 to
39e3e5b
Compare
agauniyal
approved these changes
Feb 24, 2017
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
But at "!!Improve This!!" sentences need to be completed.