From 03f1572e8f7019f956d72e3269310e17759ede1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20H=C3=BCbinette=20=28Hubbe=29?= <hubbe@hubbe.net> Date: Mon, 25 Nov 1996 13:14:32 -0800 Subject: [PATCH] doc for /precompiled/stack added Rev: doc/precompiled/stack:1.1 --- doc/precompiled/stack | 48 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 doc/precompiled/stack diff --git a/doc/precompiled/stack b/doc/precompiled/stack new file mode 100644 index 0000000000..8ea6d3121a --- /dev/null +++ b/doc/precompiled/stack @@ -0,0 +1,48 @@ +NAME + /precompiled/stack - generic stack + +DESCRIPTION + /precompiled/stack is a Pike program that implements a generic stack. + The stack can hold any amount of values. + + Only three methods are available: push(), pop() and reset() + +============================================================================ +NAME + push - push a value on the stack + +SYNTAX + #include <stack.h> + + void stack->push(mixed value) + +DESCRIPTION + This function pushes a value on top of the stack. There is always + room for more values on the stack. (Until you run out of memory.) + +============================================================================ +NAME + pop - pop a value off the stack + +SYNTAX + #include <stack.h> + + mixed stack->pop() + +DESCRIPTION + This function pops the topmost value off the stack. If there are + no values left on the stack a 'stack underflow' error is generated. + +============================================================================ +NAME + reset - remove all values from the stack + +SYNTAX + #include <stack.h> + + void stack->reset() + +DESCRIPTION + This function simply returns the stack to it's original state: empty. + +============================================================================ -- GitLab