Branch: Tag:

2001-07-25

2001-07-25 23:42:58 by Martin Nilsson <mani@lysator.liu.se>

Autodoc markup fixes.

Rev: src/builtin.cmod:1.60

1:   /* -*- c -*- -  * $Id: builtin.cmod,v 1.59 2001/07/13 11:26:37 grubba Exp $ +  * $Id: builtin.cmod,v 1.60 2001/07/25 23:42:58 nilsson Exp $    */      #include "global.h"
1126:   /*! @module String    */    - PIKECLASS Buffer +    /*! @class Buffer    *! A buffer, used for building strings. It's    *! conceptually similar to a string, but you can only @[add]
1152:    *! string result = b->get(); // also clears the buffer    *! @}    */ + PIKECLASS Buffer   {    CVAR struct string_builder str;    CVAR int initial;
1161:    void f_Buffer_add( INT32 args );       -  PIKEFUN void create( int|void size ) +     /*! @decl void create()    *!    *! Initializes a new buffer.
1171:    *! the operation of @[add()] (slightly) by passing the size to this    *! function.    */ +  PIKEFUN void create( int|void size )    {    struct Buffer_struct *str = THIS;    if( args )
1283:    REF_RETURN fp->current_object;    }    -  PIKEFUN int add( string ... arg1 ) +     /*! @decl void add(string ... data)    *!    *! Adds @[data] to the buffer. Returns the size of the buffer.    *!    */ -  +  PIKEFUN int add( string ... arg1 )    {    struct Buffer_struct *str = THIS;    int j;
1304:    RETURN str->str.s->len;    }    -  PIKEFUN string get_copy() +     /*! @decl string get_copy()    *!    *! Get the data from the buffer. Significantly slower than @[get],    *! but does not clear the buffer.    */ -  +  PIKEFUN string get_copy()    {    struct pike_string *str = THIS->str.s;    if( str )
1336:    return;    }    -  PIKEFUN string get( ) +     /*! @decl string get()    *!    *! Get the data from the buffer.
1344:    *! @note    *! This will clear the data in the buffer    */ +  PIKEFUN string get( )    {    struct Buffer_struct *str = THIS;    if( str->str.s )
1358:    return;    }    -  PIKEFUN int _sizeof() +     /*! @decl int _sizeof()    *!    *! Returns the size of the buffer.    */ -  +  PIKEFUN int _sizeof()    {    struct Buffer_struct *str = THIS;    RETURN str->str.s ? str->str.s->len : 0;
1382:    }   }    - /*! @endmodule + /*! @endclass    */    - /*! @module String -  */ -  +    /*! @class Replace    */   PIKECLASS multi_string_replace