Branch: Tag:

2009-07-13

2009-07-13 09:08:19 by Henrik Grubbström (Grubba) <grubba@grubba.org>

Added some more Autodoc mk II markup.

Rev: lib/modules/Filesystem.pmod/Monitor.pmod/basic.pike:1.2

1:   //   // Basic filesystem monitor.   // - // $Id: basic.pike,v 1.1 2009/07/13 08:55:30 grubba Exp $ + // $Id: basic.pike,v 1.2 2009/07/13 09:08:19 grubba Exp $   //   // 2009-07-09 Henrik Grubbström   //    -  + //! Basic filesystem monitor. + //! + //! This module is intended to be used for incremental scanning of + //! a filesystem. +    //! The default maximum number of seconds between checks of directories   //! in seconds.   //!
438:   }      //! Backend to use. + //! + //! If @expr{0@} (zero) - use the default backend.   protected Pike.Backend backend;      //! Call-out identifier for @[backend_check()] if in
461:    }   }    + //! Turn off nonblocking mode. + //! + //! @seealso + //! @[set_nonblocking()]   void set_blocking()   {    if (co_id) {
470:    }   }    + //! Backend check callback function. + //! + //! This function is intended to be called from a backend, + //! and performs a @[check()] followed by rescheduling + //! itself via a call to @[set_nonblocking()]. + //! + //! @seealso + //! @[check()], @[set_nonblocking()]   protected void backend_check()   {    co_id = 0;
480:    if (err) throw(err);   }    + //! Turn on nonblocking mode. + //! + //! Register suitable callbacks with the backend to automatically + //! call @[check()]. + //! + //! @[check()] and thus all the callbacks will be called from the + //! backend thread. + //! + //! @seealso + //! @[set_blocking()], @[check()].   void set_nonblocking()   {    if (co_id) return;