pike.git/ src/ program.c

Branch: Tag:

2003-04-18

2003-04-18 15:42:08 by Martin Stjernholm <mast@lysator.liu.se>

Iterators now has its own class to put doc in.

Rev: src/program.c:1.500

2:   || This file is part of Pike. For copyright information see COPYRIGHT.   || Pike is distributed under GPL, LGPL and MPL. See the file COPYING   || for more information. - || $Id: program.c,v 1.499 2003/04/17 22:51:13 mast Exp $ + || $Id: program.c,v 1.500 2003/04/18 15:42:08 mast Exp $   */      #include "global.h" - RCSID("$Id: program.c,v 1.499 2003/04/17 22:51:13 mast Exp $"); + RCSID("$Id: program.c,v 1.500 2003/04/18 15:42:08 mast Exp $");   #include "program.h"   #include "object.h"   #include "dynamic_buffer.h"
814:    *! @[predef::m_delete()]    */    - /*! @decl object lfun::_get_iterator() + /*! @decl Iterator lfun::_get_iterator()    *! -  *! Iterator creation callback. +  *! Iterator creation callback. The returned @[Iterator] instance +  *! works as a cursor that references a specific item contained (in +  *! some arbitrary sense) in this one.    *! -  *! @returns -  *! Should return an object that implements the iterator API: -  *! @dl -  *! @item -  *! @[lfun::`!()] should return @expr{0@} (zero) when not at end of stream, -  *! and @expr{1@} at end of stream. -  *! @item -  *! @[lfun::`+=()] should advance the specified number of steps. -  *! @item -  *! @[index()] should return the current index. -  *! @item -  *! @[value()] should return the current value. -  *! @enddl -  *! +     *! @seealso -  *! @[predef::Iterator], @[predef::foreach()] +  *! @[Iterator], @[get_iterator], @[predef::foreach()]    */      /*! @endnamespace