From 1eb31688b5cf16e7302d00dede87e4ea0e68c070 Mon Sep 17 00:00:00 2001 From: halw Date: Mon, 7 Mar 2011 16:49:40 +0000 Subject: [PATCH] Overhaul. Author:halw Date:2011-03-07T16:49:40.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@829 abb3cda0-5349-4a8f-a601-0c33ac3a8c38 --- .../cecil/cecil-reference/eif-protect.wiki | 38 ++++++++++++------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/documentation/current/solutions/other-languages/cecil/cecil-reference/eif-protect.wiki b/documentation/current/solutions/other-languages/cecil/cecil-reference/eif-protect.wiki index 9bdea199..c0cee372 100644 --- a/documentation/current/solutions/other-languages/cecil/cecil-reference/eif-protect.wiki +++ b/documentation/current/solutions/other-languages/cecil/cecil-reference/eif-protect.wiki @@ -1,22 +1,34 @@ [[Property:title|eif_protect]] [[Property:weight|2]] [[Property:uuid|f335a229-93c4-4f3f-6fca-9c4c190745c4]] -==SYNOPSYS== - -'''#include "eif_hector.h" +==Synopsis== -EIF_OBJECT eif_protect (EIF_REFERENCE''' ''ref''''');''' + +#include "eif_hector.h" + +EIF_OBJECT eif_protect (EIF_REFERENCE ref); + + +==Description== + +The eif_protect function protects the Eiffel reference ref from the garbage collector. It keeps a reference on it so that the garbage collector does not collect it if it is not referenced from Eiffel any longer. + +==Return value== + +The eif_protect function returns an EIF_OBJECT. This EIF_OBJECT can be used later on to access ref with [[eif_access]]. + +==Conformance== -==DESCRIPTION== -The '''eif_protect()''' function protects the Eiffel reference ''ref'' from the GC. It keeps a reference on it so that the Garbage Collector does not collect it if it is not referenced from Eiffel any longer. -==RETURN VALUE== -The '''eif_protect()''' function returns an EIF_OBJECT. This EIF_OBJECT can be used later on to access ''ref'' with '''eif_access ()'''. -==CONFORMANCE== ISE Eiffel 4.4 and later. -==COMPATIBILTY== -It is equivalent to '''henter()''', which is deprecated. -==SEE ALSO== -'''eif_access'''(1), '''eif_adopt'''(1) , '''eif_wean'''(1). + +==Compatibility== + +eif_protect is equivalent to henter, which is deprecated. +{{SeeAlso|
+[[eif_access]]
+[[eif_adopt]]
+[[eif_wean]] }} +