pike.git / src / modules / _Stdio / file.c

version» Context lines:

pike.git/src/modules/_Stdio/file.c:153:   /*! @module _Stdio    */      /*! @class Fd_ref    *!    *! Proxy class that contains stub functions    *! that call the corresponding functions in    *! @[Fd].    *!    *! Used by @[Stdio.File]. +  *! +  *! @note +  *! This is not the class you want. Use @[Stdio.File] and friends instead. +  *! +  *! @seealso +  *! @[Stdio.File], @[Stdio.FILE], @[_Stdio.Fd]    */      /*! @decl Fd _fd    *! Object to which called functions are relayed.    */    -  + /*! @decl inherit Fd +  *! +  *! Fake inherit to propagate the documentation +  *! from @[_Stdio.Fd]. +  */ +    /*! @endclass    */      /*! @class Fd    *! -  *! Low level I/O operations. Use @[Stdio.File] instead. +  *! Low level I/O operations. +  *! +  *! @note +  *! This is not the class you want. Use @[Stdio.File] and friends instead. +  *! +  *! @seealso +  *! @[Stdio.File], @[Stdio.FILE], @[_Stdio.Fd_ref]    */      /*! @decl Fd fd_factory()    *!    *! Factory creating @[Stdio.Fd] objects.    *!    *! This function is called by @[openat()], @[pipe()], @[dup()]    *! and other functions creating new file objects.    *!    *! The default implementation calls @expr{object_program(this_object())()@}
pike.git/src/modules/_Stdio/file.c:213:   /*! @endclass    */      /* The class below is not accurate, but it's the lowest exposed API    * interface, which make the functions appear where users actually    * look for them. One could perhaps put them in Fd_ref and fix the doc    * generator to show inherited functions in a better way, but if they    * only are documented in Fd then the doc has to be duplicated in at    * least Fd_ref. /mast */    - /*! @class File + /*! @class Fd    */      static struct my_file *get_file_storage(struct object *o)   {    struct my_file *f;    struct svalue *sval;    struct object *ob;    if(o->prog == file_program)    return ((struct my_file *)    (o->storage + file_program->inherits->storage_offset));