0
0
mirror of https://github.com/zeromq/libzmq.git synced 2024-12-27 07:31:03 +08:00

Problem: description of return value is cloned from zmq_atomic_counter_new

Solution: provide correct description

Fixes #2789
This commit is contained in:
Simon Giesecke 2017-10-21 17:21:00 +02:00 committed by GitHub
parent 0897b3e07b
commit 439e49bca1

View File

@ -15,13 +15,15 @@ SYNOPSIS
DESCRIPTION
-----------
The _zmq_atomic_counter_value_ function returns the value of an atomic
counter. This function uses platform specific atomic operations.
counter created by _zmq_atomic_counter_new()_. This function uses platform
specific atomic operations.
RETURN VALUE
------------
The _zmq_atomic_counter_value()_ function returns the new atomic counter
if successful. Otherwise it returns NULL.
The _zmq_atomic_counter_value()_ function returns the value of the
atomic counter. If _counter_ does not point to an atomic counter created by
_zmq_atomic_counter_new()_, the behaviour is undefined.
EXAMPLE