diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-01 17:11:32 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-01 19:18:37 -0700 |
| commit | 3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c (patch) | |
| tree | d670fc9ac327e017c62a72cbaeda4bcacda5f9dd /docs/man/nng_pipe_id.3.adoc | |
| parent | 1ef281a7fbd544c6d3384fd8a71d10dc4bb081e8 (diff) | |
| download | nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.gz nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.tar.bz2 nng-3d3fa690c4f81bf4ed0a2de42c3c8fbb9f4cca5c.zip | |
Markup fixes, ensuring links are colored properly.
It turns out that when creating cross references, we need to
make any text styling (generally literal characters) outside of
the link, to avoid having the styling override the link color.
(We prefer to have links colored for ease of use.)
While here a few other markup, and actual content, errors were fixed.
Diffstat (limited to 'docs/man/nng_pipe_id.3.adoc')
| -rw-r--r-- | docs/man/nng_pipe_id.3.adoc | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/man/nng_pipe_id.3.adoc b/docs/man/nng_pipe_id.3.adoc index b327dac2..19eed4f6 100644 --- a/docs/man/nng_pipe_id.3.adoc +++ b/docs/man/nng_pipe_id.3.adoc @@ -28,12 +28,11 @@ The `nng_pipe_id()` function returns a positive identifier for the pipe _p_, if it is valid. Otherwise it returns `-1`. -NOTE: A pipe is considered valid if it was ever opened with -<<nng_pipe_open.3#,`nng_pipe_open`>> function. +NOTE: A pipe is considered valid if it was ever created by the socket. Pipes that are allocated on the stack or statically should be initialized with the macro -<<nng_pipe.5#NNG_PIPE_INITIALIZER,`NNG_PIPE_INITIALIZER`>> to ensure that -they cannot be confused with a valid pipe before they are opened. +`<<nng_pipe.5#NNG_PIPE_INITIALIZER,NNG_PIPE_INITIALIZER>>` to ensure that +they cannot be confused with a valid pipe. == RETURN VALUES |