pike.git/
src/
program.c
Branch:
Tag:
Non-build tags
All tags
No tags
2016-12-17
2016-12-17 13:41:36 by Henrik Grubbström (Grubba) <grubba@grubba.org>
6d6b8c23b62a293a340f6889a8dea67390d0eeec (
42
lines) (+
34
/-
8
)
[
Show
|
Annotate
]
Branch:
8.1
Documentation
[LFUNs]
: Improved doc for lfun::`->=() et al.
934:
*! @[predef::`[]()], @[predef::`[..]] */
-
/*! @decl
mixed
lfun::`[]=(zero
arg1
, zero
arg2
)
+
/*! @decl
void
lfun::`[]=(zero
index
, zero
value, @
+
*! object|void context, int|void access
)
*! *! Index assignment callback. *!
-
+
*! @param index
+
*! Index to change the value of.
+
*!
+
*! @param value
+
*! The new value.
+
*!
+
*! @param context
+
*! Context in the current object to index.
+
*!
+
*! If @expr{UNDEFINED@} or left out, @expr{this_program::this@}
+
*! is to be used (ie start at the current context and ignore
+
*! any overloaded symbols).
+
*!
+
*! @param access
+
*! Access permission override. One of the following:
+
*! @int
+
*! @value 0
+
*! @value UNDEFINED
+
*! See only public symbols.
+
*! @value 1
+
*! See protected symbols as well.
+
*! @endint
+
*!
+
*! This function is to set the value at index @[index] of the current
+
*! object to @[value].
+
*!
*! @seealso *! @[predef::`[]=()], @[lfun::`->=()] */
976:
*! @[predef::`->()], @[::`->()] */
-
/*! @decl
mixed
lfun::`->=(string index, zero value, @
+
/*! @decl
void
lfun::`->=(string index, zero value, @
*! object|void context, int|void access) *! *! Arrow index assignment callback.
988:
*! The new value. *! *! @param context
-
*! Context in the current object to
start the search from
.
+
*! Context in the current object to
index.
+
*!
*! If @expr{UNDEFINED@} or left out, @expr{this_program::this@} *! is to be used (ie start at the current context and ignore *! any overloaded symbols).
1003:
*! See protected symbols as well. *! @endint *!
-
*! This function is to
index
the
current
object
with
the string
@[index]
,
-
*!
and
set it
to @[value].
+
*! This function is to
set
the
value
at
symbol
@[index]
of the current
+
*!
object
to @[value].
*!
-
*! @returns
-
*! Returns the set @[value].
-
*!
+
*! @seealso *! @[predef::`->=()], @[::`->=()], @[lfun::`[]=()] */