From cee2f921c2b7f005635ad43ccc4c89a95431a652 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20Grubbstr=C3=B6m=20=28Grubba=29?=
<grubba@grubba.org>
Date: Thu, 3 Jul 2014 15:03:23 +0200
Subject: [PATCH] Pike.identify_cycle: Improved documentation somewhat.
---
src/gc.c | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/src/gc.c b/src/gc.c
index f496627753..711723265f 100644
--- a/src/gc.c
+++ b/src/gc.c
@@ -6111,11 +6111,21 @@ void identify_loop_visit_leave(void *thing, int type, void *extra)
*!
*! Identify reference cycles in Pike datastructures.
*!
+ *! This function is typically used to identify why certain
+ *! datastructures need the @[gc] to run to be freed.
+ *!
+ *! @param x
+ *! Value that is believed to be involved in a reference cycle.
+ *!
*! @returns
- *! Returns @expr{UNDEFINED@} if @[x] is not member of a reference cycle.
- *! Otherwise returns an array identifying a cycle with @[x] as the first
- *! element, and where the elements refer to each other in order, and the
- *! last element refers to the first.
+ *! @mixed
+ *! @type zero
+ *! Returns @expr{UNDEFINED@} if @[x] is not member of a reference cycle.
+ *! @type array(mixed)
+ *! Otherwise returns an array identifying a cycle with @[x] as the first
+ *! element, and where the elements refer to each other in order, and the
+ *! last element refers to the first.
+ *! @endmixed
*/
void f_identify_cycle(INT32 args)
{
--
GitLab