Permalink
Browse files

Dox: Added OBJECT-PRECEDENCE-LIST

  • Loading branch information...
1 parent c13d4cc commit ceaf9d5600b8a6ff266e671098d86297bc06a02c Josh Marchán committed Jan 7, 2010
Showing with 25 additions and 1 deletion.
  1. +25 −1 doc/sheeple.texinfo
View
26 doc/sheeple.texinfo
@@ -563,6 +563,7 @@ of all kinds@comma{} and it has @code{=NUMBER=} as its only parent}
* childp::
* descendantp::
* object-parents::
+* object-precedence-list::
@end menu
@node object, clone, Objects Dictionary, Objects Dictionary
@@ -880,7 +881,7 @@ otherwise.
@end smallformat
@end defun
-@node object-parents, , descendantp, Objects Dictionary
+@node object-parents, object-precedence-list, descendantp, Objects Dictionary
@unnumberedsubsubsec object-parents
@defun {object-parents} object => parents
@@ -903,6 +904,29 @@ list returned by @code{OBJECT-PARENTS}.
@end defun
+@node object-precedence-list, , object-parents, Objects Dictionary
+@unnumberedsubsubsec object-precedence-list
+@defun {object-precedence-list} object => precedence-list
+
+@strong{Arguments and Values:}
+
+@var{object} --- an object.
+
+@var{precedence-list} --- a list of objects
+
+@strong{Description:}
+
+Returns a list of objects representing an ordered set of @var{object} and its
+ancestors. This same ordering of objects will be traversed by Sheeple when
+behavior that involves delegation is triggered, such as delegated property
+access or reply dispatch.
+
+@strong{Exceptional Situations:}
+
+The consequences are undefined if the user directly side-effects @var{precedence-list}.
+
+@end defun
+
@node Properties, Messages, Objects, API Documentation
@section Properties

0 comments on commit ceaf9d5

Please sign in to comment.