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_strfree.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_strfree.3.adoc')
| -rw-r--r-- | docs/man/nng_strfree.3.adoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/man/nng_strfree.3.adoc b/docs/man/nng_strfree.3.adoc index 2e6569a8..9b91306f 100644 --- a/docs/man/nng_strfree.3.adoc +++ b/docs/man/nng_strfree.3.adoc @@ -25,20 +25,20 @@ void nng_strfree(char *str); == DESCRIPTION The `nng_strfree()` function deallocates the string _str_. -This is equivalent to using <<nng_free.3#,`nng_free()`>> with +This is equivalent to using `<<nng_free.3#,nng_free()>>` with the length of _str_ plus one (for the `NUL` terminating byte) as the size. IMPORTANT: This should only be used with strings that were allocated -by <<nng_strdup.3#,`nng_strdup()`>> or -<<nng_alloc.3#,`nng_alloc()`>>. +by `<<nng_strdup.3#,nng_strdup()>>` or +`<<nng_alloc.3#,nng_alloc()>>`. In all cases, the allocation size of the string must be the same as `strlen(__str__) + 1`. IMPORTANT: Consequently, if the a string created with -<<nng_strdup.3#,`nng_strdup()`>> is modified to be shorter, then +`<<nng_strdup.3#,nng_strdup()>>` is modified to be shorter, then it is incorrect to call this function. -(The <<nng_free.3#,`nng_free()`>> function can be used instead in that +(The `<<nng_free.3#,nng_free()>>` function can be used instead in that case, using the length of the original string plus one for the size.) == RETURN VALUES |
