Branch: Tag:

2003-04-07

2003-04-07 17:28:56 by Martin Nilsson <mani@lysator.liu.se>

Use @expr where more approrpiate than @tt

Rev: lib/modules/ADT.pmod/Table.pmod:1.26
Rev: lib/modules/Crypto.pmod/aes.pike:1.2
Rev: lib/modules/Getopt.pmod:1.27
Rev: lib/modules/Parser.pmod/module.pmod:1.18
Rev: lib/modules/Protocols.pmod/DNS.pmod:1.72
Rev: lib/modules/Protocols.pmod/HTTP.pmod/Query.pike:1.56
Rev: lib/modules/Protocols.pmod/HTTP.pmod/Session.pike:1.11
Rev: lib/modules/Protocols.pmod/HTTP.pmod/module.pmod:1.37
Rev: lib/modules/Protocols.pmod/LDAP.pmod/client.pike:1.48
Rev: lib/modules/Protocols.pmod/Line.pmod:1.22
Rev: lib/modules/Protocols.pmod/SMTP.pmod:1.22
Rev: lib/modules/Sql.pmod/Sql.pike:1.64
Rev: lib/modules/Stdio.pmod/module.pmod:1.169
Rev: lib/modules/String.pmod/module.pmod:1.14
Rev: lib/modules/Tools.pmod/AutoDoc.pmod/ProcessXML.pmod:1.54
Rev: src/builtin.cmod:1.131
Rev: src/builtin_functions.c:1.483
Rev: src/cpp.c:1.117
Rev: src/dynamic_load.c:1.69
Rev: src/error.c:1.106
Rev: src/modules/DVB/dvb.c:1.19
Rev: src/modules/Gdbm/gdbmmod.c:1.24
Rev: src/modules/Gettext/gettext.c:1.15
Rev: src/modules/Gmp/mpf.cmod:1.25
Rev: src/modules/MIME/mime.c:1.37
Rev: src/modules/Mird/module.pmod.in:1.12
Rev: src/modules/Msql/msqlmod.c:1.25
Rev: src/modules/Mysql/mysql.c:1.71
Rev: src/modules/Mysql/result.c:1.29
Rev: src/modules/Yp/module.pmod.in:1.19
Rev: src/modules/_Charset/module.pmod.in:1.31
Rev: src/modules/_Crypto/arcfour.c:1.21
Rev: src/modules/_Crypto/cast.c:1.16
Rev: src/modules/_Crypto/des.c:1.28
Rev: src/modules/_Crypto/idea.c:1.22
Rev: src/modules/_Crypto/invert.c:1.17
Rev: src/modules/_Crypto/md2.c:1.17
Rev: src/modules/_Crypto/md4.c:1.6
Rev: src/modules/_Crypto/pipe.c:1.26
Rev: src/modules/_Crypto/rijndael.c:1.11
Rev: src/modules/_Crypto/sha.c:1.25
Rev: src/modules/_Ffmpeg/ffmpeg.c:1.17
Rev: src/modules/_math/math.c:1.60
Rev: src/modules/files/efuns.c:1.126
Rev: src/modules/files/file.c:1.267
Rev: src/modules/files/stat.c:1.27
Rev: src/modules/files/udp.c:1.43
Rev: src/modules/system/passwords.c:1.41
Rev: src/modules/system/system.c:1.142
Rev: src/operators.c:1.174
Rev: src/pike_search.c:1.15
Rev: src/post_modules/_ADT/circular_list.cmod:1.5
Rev: src/post_modules/_ADT/sequence.cmod:1.6
Rev: src/program.c:1.498
Rev: src/security.c:1.42
Rev: src/signal_handler.c:1.262

1:   /* -  * $Id: Line.pmod,v 1.21 2003/01/20 17:44:00 nilsson Exp $ +  * $Id: Line.pmod,v 1.22 2003/04/07 17:12:02 nilsson Exp $    *    * Line-buffered protocol handling.    *
17:    static constant line_separator = "\r\n";       //! If this variable has been set, multiple lines will be accumulated, -  //! until a line with a single @tt{'.'@} (period) is received. +  //! until a line with a single @expr{"."@} (period) is received.    //! @[handle_data()] will then be called with the accumulated data    //! as the argument.    //!    //! @note    //! @[handle_data()] is one-shot, ie it will be cleared when it is called.    //! -  //! The line with the single @tt{'.'@} (period) will not be in the +  //! The line with the single @expr{"."@} (period) will not be in the    //! accumulated data.    //!    //! @seealso
137:    //! Read a line from the input.    //!    //! @returns -  //! Returns @tt{0@} when more input is needed. +  //! Returns @expr{0@} when more input is needed.    //! Returns the requested line otherwise.    //!    //! @note
183:    //! Queue of data that is pending to send.    //!    //! The elements in the queue are either strings with data to send, -  //! or @tt{0@} (zero) which is the end of file marker. The connection +  //! or @expr{0@} (zero) which is the end of file marker. The connection    //! will be closed when the end of file marker is reached.    //!    //! @seealso
284:    //! @[timeout] is an optional timeout in seconds after which the connection    //! will be closed if there has been no data sent or received.    //! -  //! If @[timeout] is @tt{0@} (zero), no timeout will be in effect. +  //! If @[timeout] is @expr{0@} (zero), no timeout will be in effect.    //!    //! @seealso    //! @[touch_time()], @[do_timeout()]
323:    //! If @[lines] is omitted, @[errorcodes] will be used to lookup    //! an appropriate error-message.    //! -  //! If @[lines] is a string, it will be split on @tt{'\n'@} (newline), -  //! and the error-code interspersed as appropriate. +  //! If @[lines] is a string, it will be split on @expr{"\n"@} +  //! (newline), and the error-code interspersed as appropriate.    //!    //! @seealso    //! @[errorcodes]