From 439e49bca1000cf88a8a2a121405a2f477c0f37c Mon Sep 17 00:00:00 2001 From: Simon Giesecke Date: Sat, 21 Oct 2017 17:21:00 +0200 Subject: [PATCH] Problem: description of return value is cloned from zmq_atomic_counter_new Solution: provide correct description Fixes #2789 --- doc/zmq_atomic_counter_value.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/zmq_atomic_counter_value.txt b/doc/zmq_atomic_counter_value.txt index 3cd26dec..f2e34475 100644 --- a/doc/zmq_atomic_counter_value.txt +++ b/doc/zmq_atomic_counter_value.txt @@ -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