From cbe8c9ef2447bc6b061b4e722e8fc1224a886a4f Mon Sep 17 00:00:00 2001 From: Martin Nilsson <mani@lysator.liu.se> Date: Mon, 7 Apr 2003 19:28:56 +0200 Subject: [PATCH] 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 --- lib/modules/ADT.pmod/Table.pmod | 14 +-- lib/modules/Crypto.pmod/aes.pike | 7 +- lib/modules/Getopt.pmod | 40 +++---- lib/modules/Parser.pmod/module.pmod | 38 +++---- lib/modules/Protocols.pmod/DNS.pmod | 4 +- .../Protocols.pmod/HTTP.pmod/Query.pike | 14 +-- .../Protocols.pmod/HTTP.pmod/Session.pike | 8 +- .../Protocols.pmod/HTTP.pmod/module.pmod | 12 +-- .../Protocols.pmod/LDAP.pmod/client.pike | 24 ++--- lib/modules/Protocols.pmod/Line.pmod | 16 +-- lib/modules/Protocols.pmod/SMTP.pmod | 6 +- lib/modules/Sql.pmod/Sql.pike | 6 +- lib/modules/Stdio.pmod/module.pmod | 95 +++++++++-------- lib/modules/String.pmod/module.pmod | 7 +- .../Tools.pmod/AutoDoc.pmod/ProcessXML.pmod | 2 +- src/builtin.cmod | 20 ++-- src/builtin_functions.c | 100 +++++++++--------- src/cpp.c | 21 ++-- src/dynamic_load.c | 10 +- src/error.c | 6 +- src/modules/DVB/dvb.c | 6 +- src/modules/Gdbm/gdbmmod.c | 6 +- src/modules/Gettext/gettext.c | 6 +- src/modules/Gmp/mpf.cmod | 8 +- src/modules/MIME/mime.c | 10 +- src/modules/Mird/module.pmod.in | 8 +- src/modules/Msql/msqlmod.c | 9 +- src/modules/Mysql/mysql.c | 38 +++---- src/modules/Mysql/result.c | 16 +-- src/modules/Yp/module.pmod.in | 4 +- src/modules/_Charset/module.pmod.in | 11 +- src/modules/_Crypto/arcfour.c | 8 +- src/modules/_Crypto/cast.c | 4 +- src/modules/_Crypto/des.c | 4 +- src/modules/_Crypto/idea.c | 4 +- src/modules/_Crypto/invert.c | 4 +- src/modules/_Crypto/md2.c | 4 +- src/modules/_Crypto/md4.c | 4 +- src/modules/_Crypto/pipe.c | 6 +- src/modules/_Crypto/rijndael.c | 4 +- src/modules/_Crypto/sha.c | 6 +- src/modules/_Ffmpeg/ffmpeg.c | 10 +- src/modules/_math/math.c | 21 ++-- src/modules/files/efuns.c | 30 +++--- src/modules/files/file.c | 42 ++++---- src/modules/files/stat.c | 24 ++--- src/modules/files/udp.c | 10 +- src/modules/system/passwords.c | 8 +- src/modules/system/system.c | 8 +- src/operators.c | 56 +++++----- src/pike_search.c | 4 +- src/post_modules/_ADT/circular_list.cmod | 8 +- src/post_modules/_ADT/sequence.cmod | 8 +- src/program.c | 22 ++-- src/security.c | 20 ++-- src/signal_handler.c | 18 ++-- 56 files changed, 461 insertions(+), 448 deletions(-) diff --git a/lib/modules/ADT.pmod/Table.pmod b/lib/modules/ADT.pmod/Table.pmod index b05998dcac..04a50e9741 100644 --- a/lib/modules/ADT.pmod/Table.pmod +++ b/lib/modules/ADT.pmod/Table.pmod @@ -1,5 +1,5 @@ // Table.pmod by Fredrik Noring, 1998 -// $Id: Table.pmod,v 1.25 2002/10/12 12:10:40 grubba Exp $ +// $Id: Table.pmod,v 1.26 2003/04/07 17:19:41 nilsson Exp $ #pike __REAL_VERSION__ #define TABLE_ERR(msg) error("(Table) "+msg+"\n") @@ -375,8 +375,8 @@ class table { //! @param column_types //! This is an optional array of mappings. The column type //! information is only used when displaying the table. Currently, only the - //! keyword @tt{"type"@} is recognized. The type can be specified as - //! @tt{"text"@} or @tt{"num"@} (numerical). Text columns are left + //! keyword @expr{"type"@} is recognized. The type can be specified as + //! @expr{"text"@} or @expr{"num"@} (numerical). Text columns are left //! adjusted, whereas numerical columns are right adjusted. If a mapping //! in the array is 0 (zero), it will be assumed to be a text column. //! If @[column_types] is omitted, all columns will displayed as text. @@ -450,10 +450,10 @@ object ASCII = class { //! @decl string encode(object table, void|mapping options) //! - //! This method returns a table represented in ASCII suitable for human eyes. - //! @[options] is an optional mapping. If the keyword @tt{"indent"@} is used - //! with a number, the table will be indented with that number of space - //! characters. + //! This method returns a table represented in ASCII suitable for + //! human eyes. @[options] is an optional mapping. If the keyword + //! @expr{"indent"@} is used with a number, the table will be + //! indented with that number of space characters. string encode(object t, void|mapping options) { diff --git a/lib/modules/Crypto.pmod/aes.pike b/lib/modules/Crypto.pmod/aes.pike index bf6def3cd5..dd355ebaa9 100644 --- a/lib/modules/Crypto.pmod/aes.pike +++ b/lib/modules/Crypto.pmod/aes.pike @@ -1,15 +1,16 @@ /* - * $Id: aes.pike,v 1.1 2003/03/19 17:46:30 nilsson Exp $ + * $Id: aes.pike,v 1.2 2003/04/07 17:16:03 nilsson Exp $ * */ -//! Advanced Encryption Standard (AES), previously known as @[Crypto.rijndael]. +//! Advanced Encryption Standard (AES), previously known as +//! @[Crypto.rijndael]. #pike __REAL_VERSION__ inherit Crypto.rijndael; -//! Returns the string @tt{"AES"@}. +//! Returns the string @expr{"AES"@}. string name() { return "AES"; diff --git a/lib/modules/Getopt.pmod b/lib/modules/Getopt.pmod index 668bfa6b51..bc02e3dcb2 100644 --- a/lib/modules/Getopt.pmod +++ b/lib/modules/Getopt.pmod @@ -27,7 +27,7 @@ static void my_error(string err, int throw_errors) { //! //! @param argv //! The first argument should be the array of strings that was sent as -//! the second argument to your @tt{main()@} function. +//! the second argument to your @expr{main()@} function. //! //! @param shortform //! The second is a string with the short form of your option. The @@ -37,7 +37,7 @@ static void my_error(string err, int throw_errors) { //! //! @param longform //! This is an alternative and maybe more readable way to give the -//! same option. If you give @tt{"foo"@} as @[longform] your program +//! same option. If you give @expr{"foo"@} as @[longform] your program //! will accept @tt{--foo@} as argument. This argument can also be //! an array of strings, in which case any of the options in the //! array will be accepted. @@ -56,16 +56,17 @@ static void my_error(string err, int throw_errors) { //! @[UNDEFINED] or left out if the option does not take an argument. //! //! @param throw_errors -//! If @[throw_errors] has been specified @[find_option()] will throw -//! errors on failure. If it has been left out, or is @tt{0@} (zero), it will -//! instead print an error message on @[Stdio.stderr] and exit the -//! program with result code 1 on failure. +//! If @[throw_errors] has been specified @[find_option()] will +//! throw errors on failure. If it has been left out, or is +//! @expr{0@} (zero), it will instead print an error message on +//! @[Stdio.stderr] and exit the program with result code 1 on +//! failure. //! //! @returns //! Returns the value the option has been set to if any. //! -//! If the option is present, but has not been set to anything @tt{1@} -//! will be returned. +//! If the option is present, but has not been set to anything +//! @expr{1@} will be returned. //! //! Otherwise if any of the environment variables specified in @[envvars] has //! been set, that value will be returned. @@ -84,8 +85,8 @@ static void my_error(string err, int throw_errors) { //! This function reads options even if they are written after the first //! non-option on the line. //! -//! Index @tt{0@} (zero) of @[argv] is not scanned for options, since it -//! is reserved for the program name. +//! Index @expr{0@} (zero) of @[argv] is not scanned for options, +//! since it is reserved for the program name. //! //! Only the first ocurrance of an option will be parsed. To parse //! multiple ocurrances, call @[find_option()] multiple times. @@ -197,8 +198,8 @@ constant MAY_HAVE_ARG=3; //! the first non-option on the command line. //! //! @param argv -//! The should be the array of strings that was sent as -//! the second argument to your @tt{main()@} function. +//! The should be the array of strings that was sent as the second +//! argument to your @expr{main()@} function. //! //! @param options //! Each element in the array @[options] should be an array on the @@ -219,7 +220,7 @@ constant MAY_HAVE_ARG=3; //! looked for. Short and long options can be mixed, and short options //! can be combined into one string. Note that you must include the //! dashes so that @[find_all_options()] can distinguish between -//! long and short options. Example: @tt{({"-tT","--test"})@} +//! long and short options. Example: @expr{({"-tT","--test"})@} //! This would make @[find_all_options] look for @tt{-t@}, //! @tt{-T@} and @tt{--test@}. //! @elem void|string|array(string) env_var @@ -237,10 +238,11 @@ constant MAY_HAVE_ARG=3; //! Don't scan for arguments after the first non-option. //! //! @param throw_errors -//! If @[throw_errors] has been specified @[find_all_options()] will throw -//! errors on failure. If it has been left out, or is @tt{0@} (zero), it will -//! instead print an error message on @[Stdio.stderr] and exit the -//! program with result code 1 on failure. +//! If @[throw_errors] has been specified @[find_all_options()] will +//! throw errors on failure. If it has been left out, or is +//! @expr{0@} (zero), it will instead print an error message on +//! @[Stdio.stderr] and exit the program with result code 1 on +//! failure. //! //! @returns //! The good news is that the output from this function is a lot simpler. @@ -257,8 +259,8 @@ constant MAY_HAVE_ARG=3; //! @note //! @[find_all_options()] modifies @[argv]. //! -//! Index @tt{0@} (zero) of @[argv] is not scanned for options, since it -//! is reserved for the program name. +//! Index @expr{0@} (zero) of @[argv] is not scanned for options, +//! since it is reserved for the program name. //! //! @seealso //! @[Getopt.get_args()], @[Getopt.find_option()] diff --git a/lib/modules/Parser.pmod/module.pmod b/lib/modules/Parser.pmod/module.pmod index 66d193cb8c..bf80b51aeb 100644 --- a/lib/modules/Parser.pmod/module.pmod +++ b/lib/modules/Parser.pmod/module.pmod @@ -1,5 +1,5 @@ /* - * $Id: module.pmod,v 1.17 2003/04/01 17:44:04 nilsson Exp $ + * $Id: module.pmod,v 1.18 2003/04/07 17:16:41 nilsson Exp $ * */ @@ -25,27 +25,27 @@ class SGML //! //! @example //! A string -//! @tt{"<gat> <gurka> </gurka> <banan> <kiwi> </gat>"@} +//! @expr{"<gat> <gurka> </gurka> <banan> <kiwi> </gat>"@} //! results in -//! @pre{ +//!@code +//!({ +//! tag "gat" object with data: +//! ({ +//! tag "gurka" object with data: +//! ({ +//! " " +//! }) +//! tag "banan" object with data: //! ({ -//! tag "gat" object with data: +//! " " +//! tag "kiwi" object with data: //! ({ -//! tag "gurka" object with data: -//! ({ -//! " " -//! }) -//! tag "banan" object with data: -//! ({ -//! " " -//! tag "kiwi" object with data: -//! ({ -//! " " -//! }) -//! }) -//! }) -//! }) -//! @} +//! " " +//! }) +//! }) +//! }) +//!}) +//!@endcode //! //! ie, simple "tags" (not containers) are not detected, //! but containers are ended implicitely by a surrounding diff --git a/lib/modules/Protocols.pmod/DNS.pmod b/lib/modules/Protocols.pmod/DNS.pmod index 966ebda94b..f936990782 100644 --- a/lib/modules/Protocols.pmod/DNS.pmod +++ b/lib/modules/Protocols.pmod/DNS.pmod @@ -1,4 +1,4 @@ -// $Id: DNS.pmod,v 1.71 2003/01/20 17:44:00 nilsson Exp $ +// $Id: DNS.pmod,v 1.72 2003/04/07 17:12:02 nilsson Exp $ // Not yet finished -- Fredrik Hubinette //! Domain Name System @@ -452,7 +452,7 @@ class server //! Overload this function to implement the proper lookup. //! //! @returns - //! Returns @tt{0@} (zero) on failure, or a result mapping on success: + //! Returns @expr{0@} (zero) on failure, or a result mapping on success: //! @mapping //! @member int "rcode" //! @member array(mapping(string:string|int))|void "qd" diff --git a/lib/modules/Protocols.pmod/HTTP.pmod/Query.pike b/lib/modules/Protocols.pmod/HTTP.pmod/Query.pike index b518a64665..22d9fb3074 100644 --- a/lib/modules/Protocols.pmod/HTTP.pmod/Query.pike +++ b/lib/modules/Protocols.pmod/HTTP.pmod/Query.pike @@ -1,6 +1,6 @@ #pike __REAL_VERSION__ -// $Id: Query.pike,v 1.55 2003/04/01 17:42:46 nilsson Exp $ +// $Id: Query.pike,v 1.56 2003/04/07 17:12:02 nilsson Exp $ //! Open and execute an HTTP query. @@ -19,10 +19,10 @@ int ok; //! mapping headers; -//! Protocol string, ie @tt{"HTTP/1.0"@}. +//! Protocol string, ie @expr{"HTTP/1.0"@}. string protocol; -//! Status number and description (eg @tt{200@} and @tt{"ok"@}). +//! Status number and description (eg @expr{200@} and @expr{"ok"@}). int status; string status_desc; @@ -453,7 +453,7 @@ object set_callbacks(function(object,mixed...:mixed) _ok, //! to complete. //! //! @[query] is the first line sent to the HTTP server; -//! for instance @tt{"GET /index.html HTTP/1.1"@}. +//! for instance @expr{"GET /index.html HTTP/1.1"@}. //! //! @[headers] will be encoded and sent after the first line, //! and @[data] will be sent after the headers. @@ -604,7 +604,7 @@ object async_request(string server,int port,string query, //! Wait for connection to complete. //! @returns -//! Returns @tt{1@} on successfull connection, @tt{0@} on failure. +//! Returns @expr{1@} on successfull connection, @expr{0@} on failure. //! int `()() { @@ -866,7 +866,7 @@ class PseudoFile //! @decl Protocols.HTTP.Query.PseudoFile file(mapping newheaders, @ //! void|mapping removeheaders) //! Gives back a pseudo-file object, -//! with the methods @tt{read()@} and @tt{close()@}. +//! with the methods @expr{read()@} and @expr{close()@}. //! This could be used to copy the file to disc at //! a proper tempo. //! @@ -906,7 +906,7 @@ object file(void|mapping newheader,void|mapping removeheader) //! @decl Protocols.HTTP.Query.PseudoFile datafile(); //! Gives back a pseudo-file object, -//! with the methods @tt{read()@} and @tt{close()@}. +//! with the methods @expr{read()@} and @expr{close()@}. //! This could be used to copy the file to disc at //! a proper tempo. //! diff --git a/lib/modules/Protocols.pmod/HTTP.pmod/Session.pike b/lib/modules/Protocols.pmod/HTTP.pmod/Session.pike index 48a4a55cb9..576ee7332e 100644 --- a/lib/modules/Protocols.pmod/HTTP.pmod/Session.pike +++ b/lib/modules/Protocols.pmod/HTTP.pmod/Session.pike @@ -1,6 +1,6 @@ #pike __REAL_VERSION__ -// $Id: Session.pike,v 1.10 2003/03/20 20:09:42 nilsson Exp $ +// $Id: Session.pike,v 1.11 2003/04/07 17:12:02 nilsson Exp $ import Protocols.HTTP; @@ -807,10 +807,10 @@ Request post_url(URL url, //! mapping query_variables) //! @decl string post_url_data(URL url, @ //! mapping query_variables) -//! Returns an array of @tt{({content_type,data})@} and just the data -//! string respective, +//! Returns an array of @expr{({content_type,data})@} and +//! just the data string respective, //! after calling the requested server for the information. -//! 0 is returned upon failure. +//! @expr{0@} is returned upon failure. //! //! post* is similar to the @[get_url()] class of functions, //! except that the query variables is sent as a POST request instead diff --git a/lib/modules/Protocols.pmod/HTTP.pmod/module.pmod b/lib/modules/Protocols.pmod/HTTP.pmod/module.pmod index 6d7695132a..c1e41fa31f 100644 --- a/lib/modules/Protocols.pmod/HTTP.pmod/module.pmod +++ b/lib/modules/Protocols.pmod/HTTP.pmod/module.pmod @@ -76,7 +76,7 @@ object do_method(string method, //! Sends a HTTP GET request to the server in the URL //! and returns the created and initialized @[Query] object. //! 0 is returned upon failure. If a query object having -//! @tt{request_headers->Connection=="Keep-Alive"@} from a previous +//! @expr{request_headers->Connection=="Keep-Alive"@} from a previous //! request is provided and the already established server connection //! can be used for the next request, you may gain some performance. //! @@ -102,7 +102,7 @@ object get_url(string|Standards.URI url, //! Sends a HTTP PUT request to the server in the URL //! and returns the created and initialized @[Query] object. //! 0 is returned upon failure. If a query object having -//! @tt{request_headers->Connection=="Keep-Alive"@} from a previous +//! @expr{request_headers->Connection=="Keep-Alive"@} from a previous //! request is provided and the already established server connection //! can be used for the next request, you may gain some performance. //! @@ -128,7 +128,7 @@ object put_url(string|Standards.URI url, //! Sends a HTTP DELETE request to the server in the URL //! and returns the created and initialized @[Query] object. //! 0 is returned upon failure. If a query object having -//! @tt{request_headers->Connection=="Keep-Alive"@} from a previous +//! @expr{request_headers->Connection=="Keep-Alive"@} from a previous //! request is provided and the already established server connection //! can be used for the next request, you may gain some performance. //! @@ -158,8 +158,8 @@ object delete_url(string|Standards.URI url, //! mapping query_variables, @ //! mapping request_headers, @ //! object(Protocols.HTTP.Query) query) -//! Returns an array of @tt{({content_type,data})@} and just the data -//! string respective, +//! Returns an array of @expr{({content_type,data})@} and just +//! the data string respective, //! after calling the requested server for the information. //! 0 is returned upon failure. //! @@ -326,7 +326,7 @@ string http_encode_query(mapping(string:int|string) variables) //! characters for transfer in HTTP. //! //! Do not use this function to protect URLs, since -//! it will protect URL characters like @tt{'/'@} and @tt{'?'@}. +//! it will protect URL characters like @expr{'/'@} and @expr{'?'@}. //! @param in //! The string to encode //! @returns diff --git a/lib/modules/Protocols.pmod/LDAP.pmod/client.pike b/lib/modules/Protocols.pmod/LDAP.pmod/client.pike index 54afd18e38..ef2d87cbd2 100644 --- a/lib/modules/Protocols.pmod/LDAP.pmod/client.pike +++ b/lib/modules/Protocols.pmod/LDAP.pmod/client.pike @@ -2,7 +2,7 @@ // LDAP client protocol implementation for Pike. // -// $Id: client.pike,v 1.47 2003/02/07 01:00:38 nilsson Exp $ +// $Id: client.pike,v 1.48 2003/04/07 17:12:02 nilsson Exp $ // // Honza Petrous, hop@unibase.cz // @@ -350,7 +350,7 @@ int _prof_gtim; //! //! @param url //! LDAP server URL in form - //! @tt{"ldap://hostname/basedn?attrlist?scope?ext"@} + //! @expr{"ldap://hostname/basedn?attrlist?scope?ext"@} //! //! @param context //! TLS context of connection @@ -360,7 +360,7 @@ int _prof_gtim; void create(string|void url, object|void context) { - info = ([ "code_revision" : ("$Revision: 1.47 $"/" ")[1] ]); + info = ([ "code_revision" : ("$Revision: 1.48 $"/" ")[1] ]); if(!url || !sizeof(url)) url = LDAP_DEFAULT_URL; @@ -470,10 +470,10 @@ int _prof_gtim; //! by connection to the LDAP server. //! //! @param version - //! Only @tt{2@} or @tt{3@} can be entered. + //! Only @expr{2@} or @expr{3@} can be entered. //! //! @returns - //! Returns @tt{1@} on success, @tt{0@} otherwise. + //! Returns @expr{1@} on success, @expr{0@} otherwise. //! //! @note //! Only simple authentication type is implemented. So be warned @@ -558,7 +558,7 @@ int _prof_gtim; //! The distinguished name of deleted entry. //! //! @returns - //! Returns @tt{1@} on success, @tt{0@} otherwise. + //! Returns @expr{1@} on success, @expr{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ @@ -617,7 +617,7 @@ int _prof_gtim; //! The mapping of compared attributes and theirs values. //! //! @returns - //! Returns @tt{1@} on success, @tt{0@} otherwise. + //! Returns @expr{1@} on success, @expr{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ @@ -691,7 +691,7 @@ int _prof_gtim; //! of the entry being added. //! //! @returns - //! Returns @tt{1@} on success, @tt{0@} otherwise. + //! Returns @expr{1@} on success, @expr{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ @@ -938,7 +938,7 @@ int _prof_gtim; //! the attribute values. //! //! @returns - //! Returns object @[LDAP.client.result] on success, @tt{0@} + //! Returns object @[LDAP.client.result] on success, @expr{0@} //! otherwise. //! //! @note @@ -1190,7 +1190,7 @@ int _prof_gtim; //! which becomes the immediate superior of the existing entry. //! //! @returns - //! Returns @tt{1@} on success, @tt{0@} otherwise. + //! Returns @expr{1@} on success, @expr{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ @@ -1250,7 +1250,7 @@ int _prof_gtim; //! exists, and is ignored if the attribute does not exist //! //! @returns - //! Returns @tt{1@} on uccess, @tt{0@} otherwise. + //! Returns @expr{1@} on uccess, @expr{0@} otherwise. //! //! @note //! The API change: the returning code was changed in Pike 7.3+ @@ -1293,7 +1293,7 @@ int _prof_gtim; //! Gets referrals. //! //! @returns - //! Returns array of referrals or @tt{0@}. + //! Returns array of referrals or @expr{0@}. array|int get_referrals() { if(last_rv->referrals) return last_rv->referrals; diff --git a/lib/modules/Protocols.pmod/Line.pmod b/lib/modules/Protocols.pmod/Line.pmod index 7994a37dfd..4d480ab08e 100644 --- a/lib/modules/Protocols.pmod/Line.pmod +++ b/lib/modules/Protocols.pmod/Line.pmod @@ -1,5 +1,5 @@ /* - * $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,14 +17,14 @@ class simple 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,7 +137,7 @@ class simple //! 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,7 +183,7 @@ class simple //! 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,7 +284,7 @@ class simple //! @[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,8 +323,8 @@ class smtp_style //! 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] diff --git a/lib/modules/Protocols.pmod/SMTP.pmod b/lib/modules/Protocols.pmod/SMTP.pmod index 949ecf0974..700b01ce44 100644 --- a/lib/modules/Protocols.pmod/SMTP.pmod +++ b/lib/modules/Protocols.pmod/SMTP.pmod @@ -154,9 +154,9 @@ class client //! //! @note //! Some important headers are set to: - //! @tt{"Content-Type: text/plain; charset=iso-8859-1"@} and - //! @tt{"Content-Transfer-Encoding: 8bit"@}. @tt{"Date:"@} header - //! isn't used at all. + //! @expr{"Content-Type: text/plain; charset=iso-8859-1"@} and + //! @expr{"Content-Transfer-Encoding: 8bit"@}. @expr{"Date:"@} + //! header isn't used at all. //! //! @throws //! If the mail server returns any other return code than diff --git a/lib/modules/Sql.pmod/Sql.pike b/lib/modules/Sql.pmod/Sql.pike index d9317e81ea..2b323af6c6 100644 --- a/lib/modules/Sql.pmod/Sql.pike +++ b/lib/modules/Sql.pmod/Sql.pike @@ -1,5 +1,5 @@ /* - * $Id: Sql.pike,v 1.63 2003/04/01 17:43:45 nilsson Exp $ + * $Id: Sql.pike,v 1.64 2003/04/07 17:17:31 nilsson Exp $ * * Implements the generic parts of the SQL-interface * @@ -99,8 +99,8 @@ function(string:int) decode_datetime; //! @tt{dbtype://[user[:password]@@]hostname[:port][/database]@} //! Use the dbtype protocol to connect to the database server //! on the specified host. -//! If the hostname is @tt{""@}, access through a UNIX-domain -//! socket or similar, e g @tt{"mysql://root@@:/tmp/mysql.sock/"@} +//! If the hostname is @expr{""@}, access through a UNIX-domain +//! socket or similar, e g @expr{"mysql://root@@:/tmp/mysql.sock/"@} //! @type int(0..0) //! Access through a UNIX-domain socket or similar. //! @endmixed diff --git a/lib/modules/Stdio.pmod/module.pmod b/lib/modules/Stdio.pmod/module.pmod index e399d8f0bc..042449d65e 100644 --- a/lib/modules/Stdio.pmod/module.pmod +++ b/lib/modules/Stdio.pmod/module.pmod @@ -1,4 +1,4 @@ -// $Id: module.pmod,v 1.168 2003/04/01 17:42:26 nilsson Exp $ +// $Id: module.pmod,v 1.169 2003/04/07 17:15:05 nilsson Exp $ #pike __REAL_VERSION__ inherit files; @@ -170,28 +170,29 @@ class File //! Open a file for read, write or append. The parameter @[mode] should //! contain one or more of the following letters: //! @string - //! @value 'r' + //! @value "r" //! Open file for reading. - //! @value 'w' + //! @value "w" //! Open file for writing. - //! @value 'a' - //! Open file for append (use with @tt{'w'@}). - //! @value 't' - //! Truncate file at open (use with @tt{'w'@}). - //! @value 'c' - //! Create file if it doesn't exist (use with @tt{'w'@}). - //! @value 'x' - //! Fail if file already exists (use with @tt{'c'@}). + //! @value "a" + //! Open file for append (use with @expr{"w"@}). + //! @value "t" + //! Truncate file at open (use with @expr{"w"@}). + //! @value "c" + //! Create file if it doesn't exist (use with @expr{"w"@}). + //! @value "x" + //! Fail if file already exists (use with @expr{"c"@}). //! @endstring //! - //! @[mode] should always contain at least one of the letters @tt{'r'@} or - //! @tt{'w'@}. + //! @[mode] should always contain at least one of the letters + //! @expr{"r"@} or @expr{"w"@}. //! - //! The parameter @[mask] is protection bits to use if the file is created. - //! Default is @tt{0666@} (read+write for all in octal notation). + //! The parameter @[mask] is protection bits to use if the file is + //! created. Default is @expr{0666@} (read+write for all in octal + //! notation). //! //! @returns - //! This function returns 1 for success, 0 otherwise. + //! This function returns @expr{1@} for success, @expr{0@} otherwise. //! //! @seealso //! @[close()], @[create()] @@ -254,10 +255,12 @@ class File //! This function returns 1 for success, 0 otherwise. //! //! @note - //! In nonblocking mode @tt{0@} (zero) may be returned and @[errno()] set to - //! @tt{EWOULDBLOCK@} or @tt{WSAEWOULDBLOCK@}. This should not be regarded - //! as a connection failure. In nonblocking mode you need to wait for a write - //! or close callback before you know if the connection failed or not. + //! In nonblocking mode @expr{0@} (zero) may be returned and + //! @[errno()] set to @expr{EWOULDBLOCK@} or + //! @expr{WSAEWOULDBLOCK@}. This should not be regarded as a + //! connection failure. In nonblocking mode you need to wait for a + //! write or close callback before you know if the connection failed + //! or not. //! //! @seealso //! @[query_address()], @[async_connect()], @[connect_unix()] @@ -281,7 +284,7 @@ class File //! Open a UNIX domain socket connection to the specified destination. //! //! @returns - //! Returns @tt{1@} on success, and @tt{0@} on failure. + //! Returns @expr{1@} on success, and @expr{0@} on failure. //! //! @note //! Nonblocking mode is not supported while connecting @@ -354,8 +357,8 @@ class File //! //! @param callback //! Function to be called on completion. - //! The first argument will be @tt{1@} if a connection was - //! successfully estabished, and @tt{0@} (zero) on failure. + //! The first argument will be @expr{1@} if a connection was + //! successfully estabished, and @expr{0@} (zero) on failure. //! The rest of the arguments to @[callback] are passed //! verbatim from @[args]. //! @@ -363,7 +366,7 @@ class File //! Extra arguments to pass to @[callback]. //! //! @returns - //! Returns @tt{0@} on failure, and @tt{1@} if @[callback] + //! Returns @expr{0@} on failure, and @expr{1@} if @[callback] //! will be used. //! //! @note @@ -371,9 +374,9 @@ class File //! the call to this function, but it is not required. //! //! For @[callback] to be called, the backend must be active (ie - //! @[main()] must have returned @tt{-1@}). + //! @[main()] must have returned @expr{-1@}). //! - //! The socket will be in non-blocking state if @tt{1@} has been + //! The socket will be in non-blocking state if @expr{1@} has been //! returned, and any callbacks will be cleared. //! //! @seealso @@ -422,7 +425,7 @@ class File //! is created. //! //! @fixme - //! Document the @tt{PROP_@} properties. + //! Document the @expr{PROP_@} properties. //! //! @seealso //! @[Process.create_process()] @@ -464,15 +467,15 @@ class File //! the same thing as cloning and then calling @[open()], except shorter and //! faster. //! - //! The third way is to call it with @[descriptorname] of @tt{"stdin"@}, - //! @tt{"stdout"@} or @tt{"stderr"@}. This will open the specified + //! The third way is to call it with @[descriptorname] of @expr{"stdin"@}, + //! @expr{"stdout"@} or @expr{"stderr"@}. This will open the specified //! standard stream. //! //! For the advanced users, you can use the file descriptors of the //! systems (note: emulated by pike on some systems - like NT). This is //! only useful for streaming purposes on unix systems. This is @b{not //! recommended at all@} if you don't know what you're into. Default - //! @[mode] for this is @tt{"rw"@}. + //! @[mode] for this is @expr{"rw"@}. //! //! @note //! Open mode will be filtered through the system UMASK. You @@ -916,7 +919,7 @@ class File //! This function sets the @tt{id@} of this file. The @tt{id@} is mainly //! used as an identifier that is sent as the first argument to all - //! callbacks. The default @tt{id@} is @tt{0@} (zero). Another possible + //! callbacks. The default @tt{id@} is @expr{0@} (zero). Another possible //! use of the @tt{id@} is to hold all data related to this file in a //! mapping or array. //! @@ -1085,11 +1088,11 @@ class Port //! @decl void create("stdin") //! @decl void create("stdin", function accept_callback) //! - //! If the first argument is other than @tt{"stdin"@} the arguments will + //! If the first argument is other than @expr{"stdin"@} the arguments will //! be passed to @[bind()]. //! - //! When create is called with @tt{"stdin"@} as the first argument, a - //! socket is created out of the file descriptor @tt{0@}. This is only + //! When create is called with @expr{"stdin"@} as the first argument, a + //! socket is created out of the file descriptor @expr{0@}. This is only //! useful if that actually is a socket to begin with. //! //! @seealso @@ -1237,7 +1240,7 @@ class FILE //! Read one line of input with support for input conversion. //! //! @returns - //! This function returns the line read if successful, and @tt{0@} if + //! This function returns the line read if successful, and @expr{0@} if //! no more lines are available. //! //! @seealso @@ -1474,7 +1477,7 @@ class FILE //! Returns the ASCII value of the character. //! //! @note - //! Returns an @tt{int@} and not a @tt{string@} of length 1. + //! Returns an @expr{int@} and not a @expr{string@} of length 1. //! int getchar() { @@ -1606,7 +1609,7 @@ string read_file(string filename,void|int start,void|int len) //! Throws an error if @[filename] isn't a regular file. //! //! @returns -//! Returns @tt{0@} (zero) on failure to open @[filename]. +//! Returns @expr{0@} (zero) on failure to open @[filename]. //! //! Returns a string with the requested data otherwise. //! @@ -1718,10 +1721,10 @@ int file_size(string filename) } //! Append @[relative] paths to an @[absolute] path and remove any -//! @tt{"//"@}, @tt{"../"@} or @tt{"/."@} to produce a straightforward -//! absolute path as a result. +//! @expr{"//"@}, @expr{"../"@} or @expr{"/."@} to produce a +//! straightforward absolute path as a result. //! -//! @tt{"../"@} is ignorded in the relative paths if it makes the +//! @expr{"../"@} is ignorded in the relative paths if it makes the //! created path begin with something else than the absolute path //! (or so far created path). //! @@ -1921,7 +1924,7 @@ static void call_cp_cb(int len, //! //! @param cb //! Function to be called on completion. -//! The first argument will be @tt{1@} on success, and @tt{0@} (zero) +//! The first argument will be @expr{1@} on success, and @expr{0@} (zero) //! otherwise. The rest of the arguments tp @[callback] are passed //! verbatim from @[args]. //! @@ -1930,7 +1933,7 @@ static void call_cp_cb(int len, //! //! @note //! For @[callback] to be called, the backend must be active (ie -//! @[main()] must have returned @tt{-1@}). +//! @[main()] must have returned @expr{-1@}). //! //! @bugs //! Currently the file sizes are not compared, so the destination file @@ -2394,12 +2397,12 @@ static class nb_sendfile //! bytes sent as the first argument, followed by @[args]. //! //! Any of @[headers], @[from] and @[trailers] may be left out -//! by setting them to @tt{0@}. +//! by setting them to @expr{0@}. //! -//! Setting @[offset] to @tt{-1@} means send from the current position in +//! Setting @[offset] to @expr{-1@} means send from the current position in //! @[from]. //! -//! Setting @[len] to @tt{-1@} means send until @[from]'s end of file is +//! Setting @[len] to @expr{-1@} means send until @[from]'s end of file is //! reached. //! //! @note @@ -2407,7 +2410,7 @@ static class nb_sendfile //! before the function returns. //! //! For @[callback] to be called, the backend must be active (ie -//! @[main()] must have returned @tt{-1@}). +//! @[main()] must have returned @expr{-1@}). //! //! In some cases, the backend must also be active for any sending to //! be performed at all. diff --git a/lib/modules/String.pmod/module.pmod b/lib/modules/String.pmod/module.pmod index 0f6bb16aef..c1945069db 100644 --- a/lib/modules/String.pmod/module.pmod +++ b/lib/modules/String.pmod/module.pmod @@ -16,9 +16,10 @@ constant int2char = int2char; constant int2hex = int2hex; //! This function implodes a list of words to a readable string, e.g. -//! ({"straw","berry","pie"}) becomes "straw, berry and pie". -//! If the separator is omitted, the default is @tt{"and"@}. -//! If the words are numbers they are converted to strings first. +//! @expr{({"straw","berry","pie"})@} becomes @expr{"straw, berry and +//! pie"@}. If the separator is omitted, the default is +//! @expr{"and"@}. If the words are numbers they are converted to +//! strings first. //! //! @seealso //! @[`*()] diff --git a/lib/modules/Tools.pmod/AutoDoc.pmod/ProcessXML.pmod b/lib/modules/Tools.pmod/AutoDoc.pmod/ProcessXML.pmod index 773a2f9816..297d802ee5 100644 --- a/lib/modules/Tools.pmod/AutoDoc.pmod/ProcessXML.pmod +++ b/lib/modules/Tools.pmod/AutoDoc.pmod/ProcessXML.pmod @@ -153,7 +153,7 @@ static object makeWrapper(array(string) modules, object|void child) //! Non-zero if it is a Pike file. If the file contains //! style doc comments, C-mode is used despite pikeMode != 0. //! @param type -//! @tt{"class"@}, @tt{"module"@} or @tt{"namespace"@}. +//! @expr{"class"@}, @expr{"module"@} or @expr{"namespace"@}. //! @param name //! The name of the class/module/namespace. //! @param parentModules diff --git a/src/builtin.cmod b/src/builtin.cmod index 08720fda1c..01fe718d74 100644 --- a/src/builtin.cmod +++ b/src/builtin.cmod @@ -2,7 +2,7 @@ || 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: builtin.cmod,v 1.130 2003/04/07 16:19:15 mast Exp $ +|| $Id: builtin.cmod,v 1.131 2003/04/07 17:28:54 nilsson Exp $ */ #include "global.h" @@ -699,10 +699,10 @@ PIKEFUN int program_inherits(program parent, program child) *! Returns a string with filename and linenumber describing where *! the program @[p] was defined. *! - *! The returned string is of the format @tt{"@i{filename@}:@i{linenumber@}"@}. + *! The returned string is of the format @expr{"filename:linenumber"@}. *! - *! If it cannot be determined where the program was defined, @tt{0@} (zero) - *! will be returned. + *! If it cannot be determined where the program was defined, @expr{0@} + *! (zero) will be returned. */ PIKEFUN string program_defined(program p) errname Program.defined; @@ -847,8 +847,8 @@ PIKEFUN program __empty_program(int|void line, string|void file) *! *! Return the name of the function @[f]. *! - *! If @[f] is a global function defined in the runtime @tt{0@} (zero) - *! will be returned. + *! If @[f] is a global function defined in the runtime @expr{0@} + *! (zero) will be returned. *! *! @seealso *! @[function_object()] @@ -925,8 +925,8 @@ PIKEFUN string function_name(program|function func) *! *! Return the object the function @[f] is in. *! - *! If @[f] is a global function defined in the runtime @tt{0@} (zero) - *! will be returned. + *! If @[f] is a global function defined in the runtime @expr{0@} + *! (zero) will be returned. *! *! Zero will also be returned if @[f] is a constant in the *! parent class. In that case @[function_program()] can be @@ -971,8 +971,8 @@ PIKEFUN object function_object(function|program func) *! *! Return the program the function @[f] is in. *! - *! If @[f] is a global function defined in the runtime @tt{0@} (zero) - *! will be returned. + *! If @[f] is a global function defined in the runtime @expr{0@} + *! (zero) will be returned. *! *! @seealso *! @[function_name()], @[function_object()] diff --git a/src/builtin_functions.c b/src/builtin_functions.c index 5abe5cb9f9..6e8854fcbb 100644 --- a/src/builtin_functions.c +++ b/src/builtin_functions.c @@ -2,11 +2,11 @@ || 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: builtin_functions.c,v 1.482 2003/04/02 19:16:03 nilsson Exp $ +|| $Id: builtin_functions.c,v 1.483 2003/04/07 17:28:55 nilsson Exp $ */ #include "global.h" -RCSID("$Id: builtin_functions.c,v 1.482 2003/04/02 19:16:03 nilsson Exp $"); +RCSID("$Id: builtin_functions.c,v 1.483 2003/04/07 17:28:55 nilsson Exp $"); #include "interpret.h" #include "svalue.h" #include "pike_macros.h" @@ -119,7 +119,7 @@ PMOD_EXPORT void debug_f_aggregate(INT32 args) /*! @decl int hash_7_4(string s) *! @decl int hash_7_4(string s, int max) *! - *! This function will return an @tt{int@} derived from the string @[s]. + *! This function will return an @expr{int@} derived from the string @[s]. *! The same string will always hash to the same value. *! If @[max] is given, the result will be >= 0 and < @[max], otherwise *! the result will be >= 0 and <= 0x7fffffff. @@ -163,7 +163,7 @@ static void f_hash_7_4(INT32 args) /*! @decl int hash_7_0(string s) *! @decl int hash_7_0(string s, int max) *! - *! This function will return an @tt{int@} derived from the string @[s]. + *! This function will return an @expr{int@} derived from the string @[s]. *! The same string will always hash to the same value. *! If @[max] is given, the result will be >= 0 and < @[max], otherwise *! the result will be >= 0 and <= 0x7fffffff. @@ -210,7 +210,7 @@ static void f_hash_7_0( INT32 args ) /*! @decl int hash(string s) *! @decl int hash(string s, int max) *! - *! This function will return an @tt{int@} derived from the string @[s]. + *! This function will return an @expr{int@} derived from the string @[s]. *! The same string will always hash to the same value. *! If @[max] is given, the result will be >= 0 and < @[max], otherwise *! the result will be >= 0 and <= 0x7fffffff. @@ -610,7 +610,7 @@ void f_query_num_arg(INT32 args) *! @decl mixed search(mapping haystack, mixed needle, mixed|void start) *! *! Search for @[needle] in @[haystack]. Return the position of @[needle] in - *! @[haystack] or @tt{-1@} if not found. + *! @[haystack] or @expr{-1@} if not found. *! *! If the optional argument @[start] is present search is started at *! this position. @@ -759,8 +759,8 @@ PMOD_EXPORT void f_search(INT32 args) /*! @decl int has_prefix(string s, string prefix) *! - *! Returns @tt{1@} if the string @[s] starts with @[prefix], - *! returns @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if the string @[s] starts with @[prefix], + *! returns @expr{0@} (zero) otherwise. */ PMOD_EXPORT void f_has_prefix(INT32 args) { @@ -820,8 +820,8 @@ PMOD_EXPORT void f_has_prefix(INT32 args) /*! @decl int has_suffix(string s, string suffix) *! - *! Returns @tt{1@} if the string @[s] ends with @[suffix], - *! returns @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if the string @[s] ends with @[suffix], + *! returns @expr{0@} (zero) otherwise. */ PMOD_EXPORT void f_has_suffix(INT32 args) { @@ -887,8 +887,8 @@ PMOD_EXPORT void f_has_suffix(INT32 args) *! Search for @[index] in @[haystack]. *! *! @returns - *! Returns @tt{1@} if @[index] is in the index domain of @[haystack], - *! or @tt{0@} (zero) if not found. + *! Returns @expr{1@} if @[index] is in the index domain of @[haystack], + *! or @expr{0@} (zero) if not found. *! *! This function is equivalent to (but sometimes faster than): *! @@ -898,7 +898,7 @@ PMOD_EXPORT void f_has_suffix(INT32 args) *! *! @note *! A negative index in strings and arrays as recognized by the - *! index operators @tt{`[]()@} and @tt{`[]=()@} is not considered + *! index operators @expr{`[]()@} and @expr{`[]=()@} is not considered *! a proper index by @[has_index()] *! *! @seealso @@ -977,8 +977,8 @@ PMOD_EXPORT void f_has_index(INT32 args) *! Search for @[value] in @[haystack]. *! *! @returns - *! Returns @tt{1@} if @[value] is in the value domain of @[haystack], - *! or @tt{0@} (zero) if not found. + *! Returns @expr{1@} if @[value] is in the value domain of @[haystack], + *! or @expr{0@} (zero) if not found. *! *! This function is in all cases except when both arguments are strings *! equivalent to (but sometimes faster than): @@ -1088,8 +1088,8 @@ PMOD_EXPORT void f_add_constant(INT32 args) *! @decl string combine_path_nt(string absolute, string ... relative) *! *! Concatenate a relative path to an absolute path and remove any - *! @tt{"//"@}, @tt{"/.."@} or @tt{"/."@} to produce a straightforward - *! absolute path as result. + *! @expr{"//"@}, @expr{"/.."@} or @expr{"/."@} to produce a + *! straightforward absolute path as result. *! *! @[combine_path_nt()] concatenates according to NT-filesystem conventions, *! while @[combine_path_unix()] concatenates according to UNIX-style. @@ -1121,13 +1121,13 @@ PMOD_EXPORT void f_add_constant(INT32 args) *! *! @returns *! When doing a @[find_call_out()] or mapping lookup, @[zero_type()] on - *! this value will return @tt{1@} if there was no such thing present in + *! this value will return @expr{1@} if there was no such thing present in *! the mapping, or if no such @tt{call_out@} could be found. *! *! If the argument to @[zero_type()] is a destructed object or a function - *! in a destructed object, @tt{2@} will be returned. + *! in a destructed object, @expr{2@} will be returned. *! - *! In all other cases @[zero_type()] will return @tt{0@} (zero). + *! In all other cases @[zero_type()] will return @expr{0@} (zero). *! *! @seealso *! @[find_call_out()] @@ -1609,7 +1609,7 @@ void f_string_to_utf8(INT32 args) *! Throws an error if the stream is not a legal UFT8 byte-stream. *! *! Accepts and decodes the extension used by @[string_to_utf8()], if - *! @[extended] is @tt{1@}. + *! @[extended] is @expr{1@}. *! *! @seealso *! @[Locale.Charset.encoder()], @[string_to_unicode()], @[string_to_utf8()], @@ -1962,9 +1962,9 @@ PMOD_EXPORT void f_throw(INT32 args) *! *! Exit the whole Pike program with the given @[returncode]. *! - *! Using @[exit()] with any other value than @tt{0@} (zero) indicates that - *! something went wrong during execution. See your system manuals for - *! more information about return codes. + *! Using @[exit()] with any other value than @expr{0@} (zero) indicates + *! that something went wrong during execution. See your system manuals + *! for more information about return codes. *! *! @seealso *! @[_exit()] @@ -2025,7 +2025,7 @@ void f__exit(INT32 args) *! *! This function returns the number of seconds since 1 Jan 1970. *! - *! The second syntax does not call the system call @tt{time()@} as often, + *! The second syntax does not call the system call @[time()] as often, *! but is only updated in the backed (when Pike code isn't running). *! *! The third syntax can be used to measure time more preciely than one @@ -2068,8 +2068,8 @@ PMOD_EXPORT void f_time(INT32 args) *! is hopefully hard to decrypt. *! *! The second syntax is used to verify @[typed_password] against - *! @[crypted_password], and returns @tt{1@} if they match, and @tt{0@} - *! (zero) otherwise. + *! @[crypted_password], and returns @expr{1@} if they match, and + *! @expr{0@} (zero) otherwise. */ PMOD_EXPORT void f_crypt(INT32 args) { @@ -2129,7 +2129,7 @@ PMOD_EXPORT void f_crypt(INT32 args) *! *! Mark an object as destructed. *! - *! Calls @tt{o->destroy()@}, and then clears all variables in the object. + *! Calls @expr{o->destroy()@}, and then clears all variables in the object. *! *! All pointers and function pointers to this object will become zero. *! The destructed object will be freed from memory as soon as possible. @@ -2473,7 +2473,7 @@ static node *fix_aggregate_mapping_type(node *n) *! For strings an array of int with the ISO10646 codes of the characters in *! the string is returned. *! - *! For a multiset an array filled with ones (@tt{1@}) is returned. + *! For a multiset an array filled with ones (@expr{1@}) is returned. *! *! For arrays a single-level copy of @[x] is returned. *! @@ -2606,7 +2606,7 @@ PMOD_EXPORT void f_next_object(INT32 args) *! *! Return the program from which @[o] was instantiated. *! - *! If @[o] is not an object or has been destructed @tt{0@} (zero) + *! If @[o] is not an object or has been destructed @expr{0@} (zero) *! will be returned. */ PMOD_EXPORT void f_object_program(INT32 args) @@ -3214,7 +3214,7 @@ PMOD_EXPORT void f_compile(INT32 args) *! *! Set the value @[m] to use weak or normal references in its *! indices and/or values (whatever is applicable). @[state] is a - *! bitfield built by using @tt{|@} between the following flags: + *! bitfield built by using @expr{|@} between the following flags: *! *! @int *! @value Pike.WEAK_INDICES @@ -3224,11 +3224,11 @@ PMOD_EXPORT void f_compile(INT32 args) *! Use weak references for values. Only applicable for arrays *! and mappings. *! @value Pike.WEAK - *! Shorthand for @tt{Pike.WEAK_INDICES|Pike.WEAK_VALUES@}. + *! Shorthand for @expr{Pike.WEAK_INDICES|Pike.WEAK_VALUES@}. *! @endint *! *! If a flag is absent, the corresponding field will use normal - *! references. @[state] can also be @tt{1@} as a compatibility + *! references. @[state] can also be @expr{1@} as a compatibility *! measure; it's treated like @[Pike.WEAK]. *! *! @returns @@ -3277,7 +3277,7 @@ void f_set_weak_flag(INT32 args) /*! @decl int objectp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is an object, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is an object, @expr{0@} (zero) otherwise. *! *! @seealso *! @[mappingp()], @[programp()], @[arrayp()], @[stringp()], @[functionp()], @@ -3303,7 +3303,7 @@ PMOD_EXPORT void f_objectp(INT32 args) /*! @decl int functionp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is a function, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is a function, @expr{0@} (zero) otherwise. *! *! @seealso *! @[mappingp()], @[programp()], @[arrayp()], @[stringp()], @[objectp()], @@ -3323,7 +3323,7 @@ PMOD_EXPORT void f_functionp(INT32 args) /*! @decl int callablep(mixed arg) *! - *! Returns @tt{1@} if @[arg] is a callable, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is a callable, @expr{0@} (zero) otherwise. *! *! @seealso *! @[mappingp()], @[programp()], @[arrayp()], @[stringp()], @[objectp()], @@ -3641,7 +3641,7 @@ PMOD_EXPORT void ID(INT32 args) \ /*! @decl int programp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is a program, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is a program, @expr{0@} (zero) otherwise. *! *! @seealso *! @[mappingp()], @[intp()], @[arrayp()], @[stringp()], @[objectp()], @@ -3674,7 +3674,7 @@ PMOD_EXPORT void f_programp(INT32 args) /*! @decl int intp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is an int, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is an int, @expr{0@} (zero) otherwise. *! *! @seealso *! @[mappingp()], @[programp()], @[arrayp()], @[stringp()], @[objectp()], @@ -3683,7 +3683,7 @@ PMOD_EXPORT void f_programp(INT32 args) /*! @decl int mappingp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is a mapping, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is a mapping, @expr{0@} (zero) otherwise. *! *! @seealso *! @[intp()], @[programp()], @[arrayp()], @[stringp()], @[objectp()], @@ -3692,7 +3692,7 @@ PMOD_EXPORT void f_programp(INT32 args) /*! @decl int arrayp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is an array, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is an array, @expr{0@} (zero) otherwise. *! *! @seealso *! @[intp()], @[programp()], @[mappingp()], @[stringp()], @[objectp()], @@ -3701,7 +3701,7 @@ PMOD_EXPORT void f_programp(INT32 args) /*! @decl int multisetp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is a multiset, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is a multiset, @expr{0@} (zero) otherwise. *! *! @seealso *! @[intp()], @[programp()], @[arrayp()], @[stringp()], @[objectp()], @@ -3710,7 +3710,7 @@ PMOD_EXPORT void f_programp(INT32 args) /*! @decl int stringp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is a string, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is a string, @expr{0@} (zero) otherwise. *! *! @seealso *! @[intp()], @[programp()], @[arrayp()], @[multisetp()], @[objectp()], @@ -3719,7 +3719,7 @@ PMOD_EXPORT void f_programp(INT32 args) /*! @decl int floatp(mixed arg) *! - *! Returns @tt{1@} if @[arg] is a float, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if @[arg] is a float, @expr{0@} (zero) otherwise. *! *! @seealso *! @[intp()], @[programp()], @[arrayp()], @[multisetp()], @[objectp()], @@ -4069,7 +4069,7 @@ PMOD_EXPORT void f_gmtime(INT32 args) *! e.g. Windows doesn't handle a negative @[timestamp]. *! *! @note - *! The field @tt{"timezone"@} may not be available on all platforms. + *! The field @expr{"timezone"@} may not be available on all platforms. *! *! @seealso *! @[Calendar], @[gmtime()], @[time()], @[ctime()], @[mktime()] @@ -4443,7 +4443,7 @@ static int does_match(struct pike_string *s,int j, *! an asterisk matches any string. *! *! When the second argument is a string and @[str] matches - *! the glob @[glob] @tt{1@} will be returned, @tt{0@} (zero) otherwise. + *! the glob @[glob] @expr{1@} will be returned, @expr{0@} (zero) otherwise. *! *! If the second array is an array and array containing the strings in *! @[arr] that match @[glob] will be returned. @@ -6207,8 +6207,8 @@ static void f_get_prof_info(INT32 args) *! Find out if an object identifier is a variable. *! *! @returns - *! This function returns @tt{1@} if @[var] exists as a non-static variable - *! in @[o], and returns @tt{0@} (zero) otherwise. + *! This function returns @expr{1@} if @[var] exists as a non-static variable + *! in @[o], and returns @expr{0@} (zero) otherwise. *! *! @seealso *! @[indices()], @[values()] @@ -6511,8 +6511,8 @@ PMOD_EXPORT void f__list_open_fds(INT32 args) *! *! This function is mostly intended for debugging. It will search through *! all data structures in Pike looking for @[o] and print the - *! locations on stderr. @[o] can be anything but @tt{int@} or - *! @tt{float@}. + *! locations on stderr. @[o] can be anything but @expr{int@} or + *! @expr{float@}. *! *! @note *! This function only exists if the Pike runtime has been compiled @@ -7554,7 +7554,7 @@ PMOD_EXPORT void f_inherit_list(INT32 args) *! Returns a string with filename and linenumber where @[fun] *! was defined. *! - *! Returns @tt{0@} (zero) when no line can be found, e.g. for + *! Returns @expr{0@} (zero) when no line can be found, e.g. for *! builtin functions and functions in destructed objects. */ PMOD_EXPORT void f_function_defined(INT32 args) diff --git a/src/cpp.c b/src/cpp.c index 67eb2176b2..c9521f8b3e 100644 --- a/src/cpp.c +++ b/src/cpp.c @@ -2,7 +2,7 @@ || 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: cpp.c,v 1.116 2003/04/01 16:30:49 nilsson Exp $ +|| $Id: cpp.c,v 1.117 2003/04/07 17:28:55 nilsson Exp $ */ #include "global.h" @@ -197,7 +197,7 @@ void cpp_describe_exception(struct cpp *this, struct svalue *thrown) *! Get compilation handler for simulation of Pike v@[major].@[minor]. *! *! This function is called by @[cpp()] when it encounters - *! @tt{#pike@} directives. + *! @expr{#pike@} directives. *! *! @param major *! Major version. @@ -214,7 +214,7 @@ void cpp_describe_exception(struct cpp *this, struct svalue *thrown) *! Convert @[raw] from encoding @[charset] to UNICODE. *! *! This function is called by @[cpp()] when it encounters - *! @tt{#charset@} directives. + *! @expr{#charset@} directives. *! *! @param raw *! String to convert. @@ -223,7 +223,7 @@ void cpp_describe_exception(struct cpp *this, struct svalue *thrown) *! Name of encoding that @[raw] uses. *! *! @returns - *! @[raw] decoded to UNICODE, or @tt{0@} (zero) if the decoding failed. + *! @[raw] decoded to UNICODE, or @expr{0@} (zero) if the decoding failed. *! *! @seealso *! @[Locale.Charset] @@ -297,7 +297,8 @@ void cpp_describe_exception(struct cpp *this, struct svalue *thrown) /*! @decl string handle_include(string header_file, string current_file, @ *! int(0..1) is_local_ref) *! - *! Called by @[cpp()] to resolv @tt{#include@} and @tt{#string@} directives. + *! Called by @[cpp()] to resolv @expr{#include@} and @expr{#string@} + *! directives. *! *! @param header_file *! File that was requested for inclusion. @@ -309,14 +310,14 @@ void cpp_describe_exception(struct cpp *this, struct svalue *thrown) *! Specifies reference method. *! @int *! @value 0 - *! Directive was @tt{#include <@}@[header_file]@tt{>@}. + *! Directive was @expr{#include <header_file>@}. *! @value 1 - *! Directive was @tt{#include "@}@[header_file]@tt{"@}. + *! Directive was @expr{#include "header_file"@}. *! @endint *! *! @returns *! Returns the filename to pass to @[read_include()] if found, - *! and @tt{0@} (zero) on failure. + *! and @expr{0@} (zero) on failure. *! *! @seealso *! @[read_include()] @@ -331,7 +332,7 @@ void cpp_describe_exception(struct cpp *this, struct svalue *thrown) *! *! @returns *! Returns a string with the content of the header file on success, - *! and @tt{0@} (zero) on failure. + *! and @expr{0@} (zero) on failure. *! *! @seealso *! @[handle_include()] @@ -1613,7 +1614,7 @@ static int do_safe_index_call(struct pike_string *s) *! *! Preprocesses the string @[data] with Pike's builtin ANSI-C look-alike *! preprocessor. If the @[current_file] argument has not been specified, - *! it will default to @tt{"-"@}. @[charset] defaults to @tt{"ISO-10646"@}. + *! it will default to @expr{"-"@}. @[charset] defaults to @expr{"ISO-10646"@}. *! *! @seealso *! @[compile()] diff --git a/src/dynamic_load.c b/src/dynamic_load.c index eed20b7d55..d2fb62b58c 100644 --- a/src/dynamic_load.c +++ b/src/dynamic_load.c @@ -2,7 +2,7 @@ || 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: dynamic_load.c,v 1.68 2003/04/02 20:55:03 mast Exp $ +|| $Id: dynamic_load.c,v 1.69 2003/04/07 17:28:55 nilsson Exp $ */ #ifdef TESTING @@ -24,7 +24,7 @@ # include "language.h" # include "lex.h" -RCSID("$Id: dynamic_load.c,v 1.68 2003/04/02 20:55:03 mast Exp $"); +RCSID("$Id: dynamic_load.c,v 1.69 2003/04/07 17:28:55 nilsson Exp $"); #else /* TESTING */ @@ -364,14 +364,14 @@ static void cleanup_compilation(struct compilation_save *save) *! into Pike. The module is initialized and any programs or constants *! defined will immediately be available. *! - *! When a module is loaded the function @tt{pike_module_init()@} will + *! When a module is loaded the C function @tt{pike_module_init()@} will *! be called to initialize it. When Pike exits @tt{pike_module_exit()@} *! will be called. These two functions @b{must@} be available in the module. *! *! @note *! The current working directory is normally not searched for - *! dynamic modules. Please use @tt{"./name.so"@} instead of just - *! @tt{"name.so"@} to load modules from the current directory. + *! dynamic modules. Please use @expr{"./name.so"@} instead of just + *! @expr{"name.so"@} to load modules from the current directory. */ void f_load_module(INT32 args) { diff --git a/src/error.c b/src/error.c index f5635b79cc..0eee52897d 100644 --- a/src/error.c +++ b/src/error.c @@ -2,7 +2,7 @@ || 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: error.c,v 1.105 2003/04/01 14:24:19 mast Exp $ +|| $Id: error.c,v 1.106 2003/04/07 17:28:55 nilsson Exp $ */ #define NO_PIKE_SHORTHAND @@ -23,7 +23,7 @@ #include "threads.h" #include "gc.h" -RCSID("$Id: error.c,v 1.105 2003/04/01 14:24:19 mast Exp $"); +RCSID("$Id: error.c,v 1.106 2003/04/07 17:28:55 nilsson Exp $"); #undef ATTRIBUTE #define ATTRIBUTE(X) @@ -451,7 +451,7 @@ PMOD_EXPORT DECLSPEC(noreturn) void debug_fatal(const char *fmt, ...) ATTRIBUTE( *! Cast operator. *! *! @note - *! The only supported type to cast to is @tt{"array"@}, which + *! The only supported type to cast to is @expr{"array"@}, which *! generates and old-style error. */ static void f_error_cast(INT32 args) diff --git a/src/modules/DVB/dvb.c b/src/modules/DVB/dvb.c index 58d7a98e2f..8f2814dab3 100644 --- a/src/modules/DVB/dvb.c +++ b/src/modules/DVB/dvb.c @@ -2,7 +2,7 @@ || 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: dvb.c,v 1.18 2002/12/12 13:17:13 hop Exp $ +|| $Id: dvb.c,v 1.19 2003/04/07 17:24:37 nilsson Exp $ */ /* @@ -466,8 +466,8 @@ static int do_tune(int fefd, uint ifreq, uint sr) *! Frequency divided by 1000. *! *! @param pol - *! Polarization. @tt{0@} or @tt{"v"@} for vertical type, - *! @tt{1@} or @tt{"h"@} for horizontal one. + *! Polarization. @expr{0@} or @expr{"v"@} for vertical type, + *! @expr{1@} or @expr{"h"@} for horizontal one. *! *! @param sr *! The service rate parameter. diff --git a/src/modules/Gdbm/gdbmmod.c b/src/modules/Gdbm/gdbmmod.c index 6b539b2db4..e404fb4d7a 100644 --- a/src/modules/Gdbm/gdbmmod.c +++ b/src/modules/Gdbm/gdbmmod.c @@ -2,11 +2,11 @@ || 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: gdbmmod.c,v 1.23 2002/12/30 13:06:19 grubba Exp $ +|| $Id: gdbmmod.c,v 1.24 2003/04/07 17:25:04 nilsson Exp $ */ #include "global.h" -RCSID("$Id: gdbmmod.c,v 1.23 2002/12/30 13:06:19 grubba Exp $"); +RCSID("$Id: gdbmmod.c,v 1.24 2003/04/07 17:25:04 nilsson Exp $"); #include "gdbm_machine.h" #include "threads.h" @@ -124,7 +124,7 @@ void gdbmmod_fatal(char *err) *! in the database immediately. This is dangerous because the database *! can be left in an unusable state if Pike is terminated abnormally. *! - *! The default mode is @tt{"rwc"@}. + *! The default mode is @expr{"rwc"@}. *! *! @note *! The gdbm manual states that it is important that the database is diff --git a/src/modules/Gettext/gettext.c b/src/modules/Gettext/gettext.c index 518e4b5a1b..6b7070dea0 100644 --- a/src/modules/Gettext/gettext.c +++ b/src/modules/Gettext/gettext.c @@ -2,7 +2,7 @@ || 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: gettext.c,v 1.14 2002/11/26 20:54:02 grubba Exp $ +|| $Id: gettext.c,v 1.15 2003/04/07 17:27:41 nilsson Exp $ */ #include "global.h" @@ -29,7 +29,7 @@ #define sp Pike_sp -RCSID("$Id: gettext.c,v 1.14 2002/11/26 20:54:02 grubba Exp $"); +RCSID("$Id: gettext.c,v 1.15 2003/04/07 17:27:41 nilsson Exp $"); /*! @module Locale */ @@ -199,7 +199,7 @@ void f_textdomain(INT32 args) *! @[gettext()], @[dgettext()] or @[dcgettext()] are called. If @[domainname] *! is zero or an empty string, @[bindtextdomain()] returns 0. *! - *! User defined domain names cannot begin with the string @tt{"SYS_"@}. + *! User defined domain names cannot begin with the string @expr{"SYS_"@}. *! Domain names beginning with this string are reserved for system use. *! *! @returns diff --git a/src/modules/Gmp/mpf.cmod b/src/modules/Gmp/mpf.cmod index 74355dbdd5..2ac93433a5 100644 --- a/src/modules/Gmp/mpf.cmod +++ b/src/modules/Gmp/mpf.cmod @@ -2,11 +2,11 @@ || 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: mpf.cmod,v 1.24 2003/03/29 02:00:59 mast Exp $ +|| $Id: mpf.cmod,v 1.25 2003/04/07 17:26:37 nilsson Exp $ */ #include "global.h" -RCSID("$Id: mpf.cmod,v 1.24 2003/03/29 02:00:59 mast Exp $"); +RCSID("$Id: mpf.cmod,v 1.25 2003/04/07 17:26:37 nilsson Exp $"); #include "gmp_machine.h" #if defined(HAVE_GMP2_GMP_H) && defined(HAVE_LIBGMP2) @@ -319,9 +319,9 @@ PIKECLASS mpf } /*! @decl static int(0..1) _is_type(string arg) - *! The Gmp.mpf object will claim to be a @tt{"float"@}. + *! The Gmp.mpf object will claim to be a @expr{"float"@}. *! @fixme - *! Perhaps it should also return true for @tt{"object"@}? + *! Perhaps it should also return true for @expr{"object"@}? */ PIKEFUN int(0..1) _is_type(string arg) flags ID_STATIC; diff --git a/src/modules/MIME/mime.c b/src/modules/MIME/mime.c index 0542324b2f..233b62f122 100644 --- a/src/modules/MIME/mime.c +++ b/src/modules/MIME/mime.c @@ -2,7 +2,7 @@ || 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: mime.c,v 1.36 2002/11/25 15:35:32 marcus Exp $ +|| $Id: mime.c,v 1.37 2003/04/07 17:25:20 nilsson Exp $ */ /* @@ -15,7 +15,7 @@ #include "config.h" -RCSID("$Id: mime.c,v 1.36 2002/11/25 15:35:32 marcus Exp $"); +RCSID("$Id: mime.c,v 1.37 2003/04/07 17:25:20 nilsson Exp $"); #include "module.h" #include "stralloc.h" #include "pike_macros.h" @@ -910,7 +910,7 @@ static void low_tokenize( INT32 args, int mode ) *! and produce an array containing the lexical elements. *! *! Individual special characters will be returned as characters (i.e. - *! @tt{int@}s). + *! @expr{int@}s). *! *! Quoted-strings, domain-literals and atoms will be decoded and returned *! as strings. @@ -924,7 +924,7 @@ static void low_tokenize( INT32 args, int mode ) *! Domain-literals are used seldom, if at all, anyway... *! *! The set of special-characters is the one specified in RFC1521 - *! (i.e. @tt{"<", ">", "@@", ",", ";", ":", "\", "/", "?", "="@}), + *! (i.e. @expr{"<", ">", "@@", ",", ";", ":", "\", "/", "?", "="@}), *! and not the set specified in RFC822. *! *! @seealso @@ -1037,7 +1037,7 @@ static int check_encword( unsigned char *str, ptrdiff_t len ) *! This function is the inverse of the @[MIME.tokenize] function. *! *! A header field value is constructed from a sequence of lexical elements. - *! Characters (@tt{int@}s) are taken to be special-characters, whereas + *! Characters (@expr{int@}s) are taken to be special-characters, whereas *! strings are encoded as atoms or quoted-strings, depending on whether *! they contain any special characters. *! diff --git a/src/modules/Mird/module.pmod.in b/src/modules/Mird/module.pmod.in index be0a5c6019..44b796e47c 100644 --- a/src/modules/Mird/module.pmod.in +++ b/src/modules/Mird/module.pmod.in @@ -1,5 +1,5 @@ // -*- Pike -*- -// $Id: module.pmod.in,v 1.11 2002/08/09 12:27:41 nilsson Exp $ +// $Id: module.pmod.in,v 1.12 2003/04/07 17:24:15 nilsson Exp $ #pike __REAL_VERSION__ @@ -87,7 +87,7 @@ class Mird //! (200) //! @endmapping //! - //! @tt{"flags"@} is a string with any of these characters: + //! @expr{"flags"@} is a string with any of these characters: //! @string //! @value 'r' //! Readonly. @@ -300,8 +300,8 @@ class Mird //! store key:value pairs in it, you get values from keys, //! you delete keys. //! - //! For convinience, the Table object overloads @tt{`[]()@}, - //! @tt{`[]=()@}, @tt{_indices()@} and @tt{_values()@}. + //! For convinience, the Table object overloads @expr{`[]()@}, + //! @expr{`[]=()@}, @expr{_indices()@} and @expr{_values()@}. class Table { int table_id; diff --git a/src/modules/Msql/msqlmod.c b/src/modules/Msql/msqlmod.c index 46d2299357..35f44a01a8 100644 --- a/src/modules/Msql/msqlmod.c +++ b/src/modules/Msql/msqlmod.c @@ -2,7 +2,7 @@ || 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: msqlmod.c,v 1.24 2002/11/18 12:28:51 nilsson Exp $ +|| $Id: msqlmod.c,v 1.25 2003/04/07 17:23:48 nilsson Exp $ */ /* All this code is pretty useless if we don't have a msql library...*/ @@ -33,7 +33,7 @@ #include "operators.h" #include "multiset.h" -RCSID("$Id: msqlmod.c,v 1.24 2002/11/18 12:28:51 nilsson Exp $"); +RCSID("$Id: msqlmod.c,v 1.25 2003/04/07 17:23:48 nilsson Exp $"); #include "version.h" #ifdef _REENTRANT @@ -251,8 +251,9 @@ static void do_reload_acl (INT32 args) *! With one argument, this function *! tries to connect to the specified (use hostname or IP address) database *! server. To connect to a server running on the local host via UNIX domain - *! sockets use @tt{"localhost"@}. To connect to the local host via TCP/IP sockets - *! you have to use the IP address @tt{"127.0.0.1"@}. + *! sockets use @expr{"localhost"@}. To connect to the local host via TCP/IP + *! sockets + *! you have to use the IP address @expr{"127.0.0.1"@}. *! With two arguments it also selects a database to use on the server. *! With no arguments it tries to connect to the server on localhost, using *! UNIX sockets. diff --git a/src/modules/Mysql/mysql.c b/src/modules/Mysql/mysql.c index 52e2076011..37f469badf 100644 --- a/src/modules/Mysql/mysql.c +++ b/src/modules/Mysql/mysql.c @@ -2,7 +2,7 @@ || 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: mysql.c,v 1.70 2003/02/26 18:17:42 agehall Exp $ +|| $Id: mysql.c,v 1.71 2003/04/07 17:23:15 nilsson Exp $ */ /* @@ -94,7 +94,7 @@ * Globals */ -RCSID("$Id: mysql.c,v 1.70 2003/02/26 18:17:42 agehall Exp $"); +RCSID("$Id: mysql.c,v 1.71 2003/04/07 17:23:15 nilsson Exp $"); /*! @module Mysql *! @@ -489,8 +489,8 @@ static void pike_mysql_reconnect(void) *! done with this function. *! *! @param host - *! If you give no argument, or give @tt{""@} as @[host] it will connect with - *! a UNIX-domain socket, which can be a big performance gain. + *! If you give no argument, or give @expr{""@} as @[host] it will connect + *! with a UNIX-domain socket, which can be a big performance gain. *! *! @param options *! This optional mapping can contain zero or more of the following @@ -507,7 +507,7 @@ static void pike_mysql_reconnect(void) *! Enable compressed protocol. *! *! @member string "mysql_config_file" - *! Change config file from @tt{"my.cnf"@}. + *! Change config file from @expr{"my.cnf"@}. *! *! @member string "mysql_group" *! Specify additional group to read from config file. @@ -549,12 +549,12 @@ static void pike_mysql_reconnect(void) *! Some options may not be implemented. Unimplemented options are *! silently ignored. *! - *! To use SSL-connections, set the SSL-parameters correctly. They corespond to - *! the parameters given to the mysql-client with the same name so make sure that - *! the mysql-client works with SSL and set these parameters to the same values and - *! everything should work. - *! If SSL-options are loaded from a config-file, one may set the connect_options to - *! include CLIENT_SSL. + *! To use SSL-connections, set the SSL-parameters correctly. They corespond + *! to the parameters given to the mysql-client with the same name so make + *! sure that the mysql-client works with SSL and set these parameters to + *! the same values and everything should work. If SSL-options are loaded + *! from a config-file, one may set the connect_options to include + *! CLIENT_SSL. */ static void f_create(INT32 args) { @@ -725,7 +725,7 @@ static void f_insert_id(INT32 args) *! *! Returns a string describing the last error from the Mysql-server. *! - *! Returns @tt{0@} (zero) if there was no error. + *! Returns @expr{0@} (zero) if there was no error. */ static void f_error(INT32 args) { @@ -823,7 +823,7 @@ static void f_select_db(INT32 args) *! This function sends the SQL query @[query] to the Mysql-server. The result *! of the query is returned as a @[Mysql.mysql_result] object. *! - *! Returns @tt{0@} (zero) if the query didn't return any result + *! Returns @expr{0@} (zero) if the query didn't return any result *! (e.g. @tt{INSERT@} or similar). *! *! @seealso @@ -1484,10 +1484,12 @@ static void f_list_tables(INT32 args) *! @endmapping *! *! The type of the field can be any of: - *! @tt{"decimal"@}, @tt{"char"@}, @tt{"short"@}, @tt{"long"@}, - *! @tt{"float"@}, @tt{"double"@}, @tt{"null"@}, @tt{"time"@}, - *! @tt{"longlong"@}, @tt{"int24"@}, @tt{"tiny blob"@}, @tt{"medium blob"@}, - *! @tt{"long blob"@}, @tt{"var string"@}, @tt{"string"@} or @tt{"unknown"@}. + *! @expr{"decimal"@}, @expr{"char"@}, @expr{"short"@}, @expr{"long"@}, + *! @expr{"float"@}, @expr{"double"@}, @expr{"null"@}, @expr{"time"@}, + *! @expr{"longlong"@}, @expr{"int24"@}, @expr{"tiny blob"@}, + *! @expr{"medium blob"@}, + *! @expr{"long blob"@}, @expr{"var string"@}, @expr{"string"@} or + *! @expr{"unknown"@}. *! *! The flags multiset can contain any of: *! @multiset @@ -1672,7 +1674,7 @@ static void f_list_processes(INT32 args) *! and retreived with this version of the mysql-module. *! *! Usually, there is no problem storing binary data in mysql-tables, - *! but data containing @tt{'\0'@} (NUL) couldn't be fetched with old + *! but data containing @expr{'\0'@} (NUL) couldn't be fetched with old *! versions (prior to 3.20.5) of the mysql-library. */ static void f_binary_data(INT32 args) diff --git a/src/modules/Mysql/result.c b/src/modules/Mysql/result.c index 5ee8791d76..91d825db6e 100644 --- a/src/modules/Mysql/result.c +++ b/src/modules/Mysql/result.c @@ -2,7 +2,7 @@ || 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: result.c,v 1.28 2002/10/20 22:05:07 marcus Exp $ +|| $Id: result.c,v 1.29 2003/04/07 17:23:15 nilsson Exp $ */ /* @@ -87,7 +87,7 @@ * Globals */ -RCSID("$Id: result.c,v 1.28 2002/10/20 22:05:07 marcus Exp $"); +RCSID("$Id: result.c,v 1.29 2003/04/07 17:23:15 nilsson Exp $"); struct program *mysql_result_program = NULL; @@ -343,7 +343,7 @@ static void f_field_seek(INT32 args) *! *! Sense end of result table. *! - *! Returns @tt{1@} when all rows have been read, and @tt{0@} (zero) + *! Returns @expr{1@} when all rows have been read, and @expr{0@} (zero) *! otherwise. *! *! @seealso @@ -366,11 +366,11 @@ static void f_eof(INT32 args) *! Return specification of the current field. *! *! Returns a mapping with information about the current field, and - *! advances the field cursor one step. Returns @tt{0@} (zero) if + *! advances the field cursor one step. Returns @expr{0@} (zero) if *! there are no more fields. *! *! The mapping contains the same entries as those returned by - *! @[Mysql.mysql->list_fields()], except that the entry @tt{"default"@} + *! @[Mysql.mysql->list_fields()], except that the entry @expr{"default"@} *! is missing. *! *! @note @@ -413,10 +413,10 @@ static void f_fetch_field(INT32 args) *! *! The returned data is similar to the data returned by *! @[Mysql.mysql->list_fields()], except for that the entry - *! @tt{"default"@} is missing. + *! @expr{"default"@} is missing. *! *! @note - *! Resets the field cursor to @tt{0@} (zero). + *! Resets the field cursor to @expr{0@} (zero). *! *! This function always exists even when @[fetch_field()] and *! @[field_seek()] don't. @@ -481,7 +481,7 @@ static void f_seek(INT32 args) *! Returns an array with the contents of the next row in the result. *! Advances the row cursor to the next now. *! - *! Returns @tt{0@} (zero) at the end of the table. + *! Returns @expr{0@} (zero) at the end of the table. *! *! @seealso *! @[seek()] diff --git a/src/modules/Yp/module.pmod.in b/src/modules/Yp/module.pmod.in index d18d7930d6..e82bf59e9b 100644 --- a/src/modules/Yp/module.pmod.in +++ b/src/modules/Yp/module.pmod.in @@ -3,7 +3,7 @@ // YP (NIS) Functionality for Pike // Per Hedbor & Henrik Grubbstr�m 1996-1997 // -// $Id: module.pmod.in,v 1.18 2002/11/28 06:04:32 nilsson Exp $ +// $Id: module.pmod.in,v 1.19 2003/04/07 17:22:53 nilsson Exp $ #pike __REAL_VERSION__ inherit @module@; @@ -90,7 +90,7 @@ class Map { //! For each entry in the map, call the function @[fun]. //! //! The function will be called like - //! @tt{void fun(string key, string value)@}. + //! @expr{void fun(string key, string value)@}. //! void map(function(string,string:void) fun) { diff --git a/src/modules/_Charset/module.pmod.in b/src/modules/_Charset/module.pmod.in index 6f354aeec5..1312fc52ff 100644 --- a/src/modules/_Charset/module.pmod.in +++ b/src/modules/_Charset/module.pmod.in @@ -9,9 +9,9 @@ static private inherit @module@; //! The Charset module supports a wide variety of different character sets, and //! it is flexible in regard of the names of character sets it accepts. The //! character case is ignored, as are the most common non-alaphanumeric -//! characters appearing in character set names. E.g. @tt{"iso-8859-1"@} works -//! just as well as @tt{"ISO_8859_1"@}. All encodings specified in RFC 1345 are -//! supported. +//! characters appearing in character set names. E.g. @expr{"iso-8859-1"@} +//! works just as well as @expr{"ISO_8859_1"@}. All encodings specified in +//! RFC 1345 are supported. //! //! First of all the Charset module is capable of handling the following //! encodings of Unicode: @@ -80,7 +80,7 @@ static private inherit @module@; //! @item 918 //! @item 950 //! @item 1026 -//! These may be prefixed with @tt{"cp"@} or @tt{"ibm"@}. +//! These may be prefixed with @expr{"cp"@} or @expr{"ibm"@}. //! @item 1250 //! @item 1251 //! @item 1252 @@ -90,7 +90,8 @@ static private inherit @module@; //! @item 1256 //! @item 1257 //! @item 1258 -//! These may be prefixed with @tt{"cp"@}, @tt{"ibm"@} or @tt{"windows"@}. +//! These may be prefixed with @expr{"cp"@}, @expr{"ibm"@} or +//! @expr{"windows"@}. //! @endul //! //! +359 more. diff --git a/src/modules/_Crypto/arcfour.c b/src/modules/_Crypto/arcfour.c index e46c240dfa..a8cb24a233 100644 --- a/src/modules/_Crypto/arcfour.c +++ b/src/modules/_Crypto/arcfour.c @@ -2,7 +2,7 @@ || 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: arcfour.c,v 1.20 2002/10/21 17:06:23 marcus Exp $ +|| $Id: arcfour.c,v 1.21 2003/04/07 17:20:45 nilsson Exp $ */ /* arcfour.c @@ -26,7 +26,7 @@ #define sp Pike_sp -RCSID("$Id: arcfour.c,v 1.20 2002/10/21 17:06:23 marcus Exp $"); +RCSID("$Id: arcfour.c,v 1.21 2003/04/07 17:20:45 nilsson Exp $"); #undef THIS #define THIS ((struct arcfour_ctx *)(Pike_fp->current_storage)) @@ -53,7 +53,7 @@ void exit_pike_arcfour(struct object *o) /*! @decl string name() *! - *! Returns the string @tt{"ARCFOUR"@}. + *! Returns the string @expr{"ARCFOUR"@}. */ static void f_name(INT32 args) { @@ -66,7 +66,7 @@ static void f_name(INT32 args) /*! @decl int query_key_length() *! *! Returns the minimum required encryption key length. - *! Currently this is @tt{1@}. + *! Currently this is @expr{1@}. */ static void f_query_key_length(INT32 args) { diff --git a/src/modules/_Crypto/cast.c b/src/modules/_Crypto/cast.c index ed44d10353..436b06d89a 100644 --- a/src/modules/_Crypto/cast.c +++ b/src/modules/_Crypto/cast.c @@ -2,7 +2,7 @@ || 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: cast.c,v 1.15 2003/04/01 18:12:42 nilsson Exp $ +|| $Id: cast.c,v 1.16 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -74,7 +74,7 @@ void exit_pike_crypto_cast(struct object *o) /*! @decl string name() *! - *! Returns the string @tt{"CAST"@}. + *! Returns the string @expr{"CAST"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Crypto/des.c b/src/modules/_Crypto/des.c index fd75b0487f..27c29e3d14 100644 --- a/src/modules/_Crypto/des.c +++ b/src/modules/_Crypto/des.c @@ -2,7 +2,7 @@ || 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: des.c,v 1.27 2002/10/21 17:06:24 marcus Exp $ +|| $Id: des.c,v 1.28 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -92,7 +92,7 @@ static void exit_pike_crypto_des(struct object *o) /*! @decl string name() *! - *! Return the string @tt{"DES"@}. + *! Return the string @expr{"DES"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Crypto/idea.c b/src/modules/_Crypto/idea.c index 8f0cdd4f5e..cbae48d86c 100644 --- a/src/modules/_Crypto/idea.c +++ b/src/modules/_Crypto/idea.c @@ -2,7 +2,7 @@ || 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: idea.c,v 1.21 2002/10/21 17:06:24 marcus Exp $ +|| $Id: idea.c,v 1.22 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -70,7 +70,7 @@ void exit_pike_crypto_idea(struct object *o) /*! @decl string name() *! - *! Return the string @tt{"IDEA"@}. + *! Return the string @expr{"IDEA"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Crypto/invert.c b/src/modules/_Crypto/invert.c index db0f4efffd..4a01ddb26a 100644 --- a/src/modules/_Crypto/invert.c +++ b/src/modules/_Crypto/invert.c @@ -2,7 +2,7 @@ || 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: invert.c,v 1.16 2002/10/21 17:06:24 marcus Exp $ +|| $Id: invert.c,v 1.17 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -64,7 +64,7 @@ void exit_pike_crypto_invert(struct object *o) /*! @decl string name() *! - *! Returns the string @tt{"INVERT"@}. + *! Returns the string @expr{"INVERT"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Crypto/md2.c b/src/modules/_Crypto/md2.c index 5827752b06..c4d9c55f72 100644 --- a/src/modules/_Crypto/md2.c +++ b/src/modules/_Crypto/md2.c @@ -2,7 +2,7 @@ || 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: md2.c,v 1.16 2002/10/21 17:06:24 marcus Exp $ +|| $Id: md2.c,v 1.17 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -48,7 +48,7 @@ static struct program *md2mod_program; /*! @decl string name() *! - *! Returns the string @tt{"MD2"@}. + *! Returns the string @expr{"MD2"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Crypto/md4.c b/src/modules/_Crypto/md4.c index 29bfdbc27c..aa245f780f 100644 --- a/src/modules/_Crypto/md4.c +++ b/src/modules/_Crypto/md4.c @@ -2,7 +2,7 @@ || 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: md4.c,v 1.5 2002/10/21 17:06:24 marcus Exp $ +|| $Id: md4.c,v 1.6 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -42,7 +42,7 @@ static struct program *md4mod_program; /*! @decl string name() *! - *! Return the string @tt{"MD4"@}. + *! Return the string @expr{"MD4"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Crypto/pipe.c b/src/modules/_Crypto/pipe.c index 16b33558d8..5ac8c1f4a1 100644 --- a/src/modules/_Crypto/pipe.c +++ b/src/modules/_Crypto/pipe.c @@ -2,7 +2,7 @@ || 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: pipe.c,v 1.25 2002/10/21 17:06:24 marcus Exp $ +|| $Id: pipe.c,v 1.26 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -174,9 +174,9 @@ static void f_create(INT32 args) /*! @decl string name() *! - *! Returns the string @tt{"PIPE("@} followed by a + *! Returns the string @expr{"PIPE("@} followed by a *! comma-separated list of the names of contained ciphers, and - *! terminated with the string @tt{")"@}. + *! terminated with the string @expr{")"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Crypto/rijndael.c b/src/modules/_Crypto/rijndael.c index ece6839caa..3657e0122f 100644 --- a/src/modules/_Crypto/rijndael.c +++ b/src/modules/_Crypto/rijndael.c @@ -2,7 +2,7 @@ || 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: rijndael.c,v 1.10 2002/10/21 17:06:24 marcus Exp $ +|| $Id: rijndael.c,v 1.11 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -93,7 +93,7 @@ static void exit_pike_crypto_rijndael(struct object *o) /*! @decl string name() *! - *! Returns the string @tt{"RIJNDAEL"@}. + *! Returns the string @expr{"RIJNDAEL"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Crypto/sha.c b/src/modules/_Crypto/sha.c index fd6a3b0ed2..8f3c11efba 100644 --- a/src/modules/_Crypto/sha.c +++ b/src/modules/_Crypto/sha.c @@ -2,7 +2,7 @@ || 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: sha.c,v 1.24 2002/10/21 17:06:24 marcus Exp $ +|| $Id: sha.c,v 1.25 2003/04/07 17:20:45 nilsson Exp $ */ /* @@ -22,7 +22,7 @@ #include "module_support.h" #include "las.h" -RCSID("$Id: sha.c,v 1.24 2002/10/21 17:06:24 marcus Exp $"); +RCSID("$Id: sha.c,v 1.25 2003/04/07 17:20:45 nilsson Exp $"); #include <sha.h> @@ -43,7 +43,7 @@ static struct program *shamod_program; /*! @decl string name() *! - *! Returns the string @tt{"SHA"@}. + *! Returns the string @expr{"SHA"@}. */ static void f_name(INT32 args) { diff --git a/src/modules/_Ffmpeg/ffmpeg.c b/src/modules/_Ffmpeg/ffmpeg.c index ca68025337..e5884c24d8 100644 --- a/src/modules/_Ffmpeg/ffmpeg.c +++ b/src/modules/_Ffmpeg/ffmpeg.c @@ -2,7 +2,7 @@ || 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: ffmpeg.c,v 1.16 2003/02/07 07:39:56 mirar Exp $ +|| $Id: ffmpeg.c,v 1.17 2003/04/07 17:22:36 nilsson Exp $ */ /* @@ -218,8 +218,8 @@ static void f_codec_info(INT32 args) { *! Sets one codec parameter *! *! @param name - *! The name of parameter. One of @tt{"sample_rate"@}, @tt{"bit_rate"@}, - *! @tt{"channels"@}. + *! The name of parameter. One of @expr{"sample_rate"@}, + *! @expr{"bit_rate"@}, @expr{"channels"@}. *! *! @returns *! Returns 1 on success, 0 otherwise (parameter not known). @@ -319,7 +319,7 @@ static void f_get_codec_status(INT32 args) { *! @decl int decode(string data, function shuffler) *! *! Decode all @[data] buffer and pass result to @[shuffler]. - *! Returns @tt{1@} on success, @tt{0@} otherwise. + *! Returns @expr{1@} on success, @expr{0@} otherwise. *! *! @note *! Shuffler variant isn't implemented, yet. @@ -388,7 +388,7 @@ static void f_decode(INT32 args) { * @[data] which was used for encoding. * * @decl int encode(string data, function shuffler); - * Returns @tt{1@} on success, @tt{0@} otherwise. + * Returns @expr{1@} on success, @expr{0@} otherwise. * * @note * Usable only in encoder diff --git a/src/modules/_math/math.c b/src/modules/_math/math.c index b70bc4331d..9f6e6d6832 100644 --- a/src/modules/_math/math.c +++ b/src/modules/_math/math.c @@ -2,7 +2,7 @@ || 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: math.c,v 1.59 2003/04/01 18:12:05 nilsson Exp $ +|| $Id: math.c,v 1.60 2003/04/07 17:21:57 nilsson Exp $ */ #include "global.h" @@ -38,7 +38,7 @@ if(sp[-1].type!=T_FLOAT) SIMPLE_BAD_ARG_ERROR(X, 1, "float") -RCSID("$Id: math.c,v 1.59 2003/04/01 18:12:05 nilsson Exp $"); +RCSID("$Id: math.c,v 1.60 2003/04/07 17:21:57 nilsson Exp $"); #ifndef M_PI #define M_PI 3.1415926535897932384626433832795080 @@ -352,8 +352,8 @@ void f_pow(INT32 args) *! Return the closest integer value less or equal to @[f]. *! *! @note - *! @[floor()] does @b{not@} return an @tt{int@}, merely an integer value - *! stored in a @tt{float@}. + *! @[floor()] does @b{not@} return an @expr{int@}, merely an integer value + *! stored in a @expr{float@}. *! *! @seealso *! @[ceil()], @[round()] @@ -370,8 +370,8 @@ void f_floor(INT32 args) *! Return the closest integer value greater or equal to @[f]. *! *! @note - *! @[ceil()] does @b{not@} return an @tt{int@}, merely an integer value - *! stored in a @tt{float@}. + *! @[ceil()] does @b{not@} return an @expr{int@}, merely an integer value + *! stored in a @expr{float@}. *! *! @seealso *! @[floor()], @[round()] @@ -388,8 +388,8 @@ void f_ceil(INT32 args) *! Return the closest integer value to @[f]. *! *! @note - *! @[round()] does @b{not@} return an @tt{int@}, merely an integer value - *! stored in a @tt{float@}. + *! @[round()] does @b{not@} return an @expr{int@}, merely an integer value + *! stored in a @expr{float@}. *! *! @seealso *! @[floor()], @[ceil()] @@ -490,8 +490,9 @@ void f_abs(INT32 args) *! Check the sign of a value. *! *! @returns - *! Returns @tt{-1@} if @[value] is less than @[zero], - *! @tt{1@} if @[value] is greater than @[zero] and @tt{0@} (zero) otherwise. + *! Returns @expr{-1@} if @[value] is less than @[zero], + *! @expr{1@} if @[value] is greater than @[zero] and @expr{0@} + *! (zero) otherwise. *! *! @seealso *! @[abs()] diff --git a/src/modules/files/efuns.c b/src/modules/files/efuns.c index 5a7e689cfc..0afb1a52c0 100644 --- a/src/modules/files/efuns.c +++ b/src/modules/files/efuns.c @@ -2,7 +2,7 @@ || 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: efuns.c,v 1.125 2003/04/01 18:11:45 nilsson Exp $ +|| $Id: efuns.c,v 1.126 2003/04/07 17:21:13 nilsson Exp $ */ #include "global.h" @@ -26,7 +26,7 @@ #include "file_machine.h" #include "file.h" -RCSID("$Id: efuns.c,v 1.125 2003/04/01 18:11:45 nilsson Exp $"); +RCSID("$Id: efuns.c,v 1.126 2003/04/07 17:21:13 nilsson Exp $"); #ifdef HAVE_SYS_TYPES_H #include <sys/types.h> @@ -141,10 +141,10 @@ struct array *encode_stat(PIKE_STAT_T *s) *! *! Stat a file. *! - *! If the argument @[symlink] is @tt{1@} symlinks will not be followed. + *! If the argument @[symlink] is @expr{1@} symlinks will not be followed. *! *! @returns - *! If the path specified by @[path] doesn't exist @tt{0@} (zero) will + *! If the path specified by @[path] doesn't exist @expr{0@} (zero) will *! be returned. *! *! Otherwise an object describing the properties of @[path] will be @@ -306,7 +306,7 @@ void f_file_truncate(INT32 args) *! containing the path specified by @[path]. *! *! @returns - *! If a filesystem cannot be determined @tt{0@} (zero) will be returned. + *! If a filesystem cannot be determined @expr{0@} (zero) will be returned. *! *! Otherwise a mapping(string:int) with the following fields will be *! returned: @@ -319,7 +319,7 @@ void f_file_truncate(INT32 args) *! Number of free blocks in the filesystem. *! @member int "bavail" *! Number of available blocks in the filesystem. - *! This is usually somewhat less than the @tt{"bfree"@} value, and + *! This is usually somewhat less than the @expr{"bfree"@} value, and *! can usually be adjusted with eg tunefs(1M). *! @member int "files" *! Total number of files (aka inodes) allowed by this filesystem. @@ -327,12 +327,12 @@ void f_file_truncate(INT32 args) *! Number of free files in the filesystem. *! @member int "favail" *! Number of available files in the filesystem. - *! This is usually the same as the @tt{"ffree"@} value, and can + *! This is usually the same as the @expr{"ffree"@} value, and can *! usually be adjusted with eg tunefs(1M). *! @member int "fsname" *! Name assigned to the filesystem. *! @member int "fstype" - *! Type of filesystem (eg @tt{"nfs"@}). + *! Type of filesystem (eg @expr{"nfs"@}). *! @endmapping *! *! @note @@ -600,7 +600,7 @@ void f_werror(INT32 args) *! Remove a file or directory. *! *! @returns - *! Returns @tt{0@} (zero) on failure, @tt{1@} otherwise. + *! Returns @expr{0@} (zero) on failure, @expr{1@} otherwise. *! *! @seealso *! @[mkdir()], @[Stdio.recursive_rm()] @@ -679,10 +679,10 @@ void f_rm(INT32 args) *! Create a directory. *! *! If @[mode] is specified, it's will be used for the new directory after - *! being @tt{&@}'ed with the current umask (on OS'es that support this). + *! being @expr{&@}'ed with the current umask (on OS'es that support this). *! *! @returns - *! Returns @tt{0@} (zero) on failure, @tt{1@} otherwise. + *! Returns @expr{0@} (zero) on failure, @expr{1@} otherwise. *! *! @seealso *! @[rm()], @[cd()], @[Stdio.mkdirhier()] @@ -804,7 +804,7 @@ void f_mkdir(INT32 args) /*! @decl array(string) get_dir(string dirname) *! *! Returns an array of all filenames in the directory @[dirname], or - *! @tt{0@} (zero) if the directory does not exist. + *! @expr{0@} (zero) if the directory does not exist. *! *! @seealso *! @[mkdir()], @[cd()] @@ -1000,7 +1000,7 @@ void f_get_dir(INT32 args) *! Change the current directory for the whole Pike process. *! *! @returns - *! Returns @tt{1@} for success, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} for success, @expr{0@} (zero) otherwise. *! *! @seealso *! @[getcwd()] @@ -1088,7 +1088,7 @@ void f_getcwd(INT32 args) *! *! @returns *! This function only returns if something went wrong during @tt{exece(2)@}, - *! and in that case it returns @tt{0@} (zero). + *! and in that case it returns @expr{0@} (zero). *! *! @note *! The Pike driver _dies_ when this function is called. You must either @@ -1225,7 +1225,7 @@ void f_exece(INT32 args) *! them. *! *! @returns - *! Returns @tt{0@} (zero) on failure, @tt{1@} otherwise. Call + *! Returns @expr{0@} (zero) on failure, @expr{1@} otherwise. Call *! @[errno()] to get more error info on failure. *! *! @seealso diff --git a/src/modules/files/file.c b/src/modules/files/file.c index 4cff7f9aa6..e057a56900 100644 --- a/src/modules/files/file.c +++ b/src/modules/files/file.c @@ -2,12 +2,12 @@ || 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: file.c,v 1.266 2003/04/01 18:58:28 mast Exp $ +|| $Id: file.c,v 1.267 2003/04/07 17:21:13 nilsson Exp $ */ #define NO_PIKE_SHORTHAND #include "global.h" -RCSID("$Id: file.c,v 1.266 2003/04/01 18:58:28 mast Exp $"); +RCSID("$Id: file.c,v 1.267 2003/04/07 17:21:13 nilsson Exp $"); #include "fdlib.h" #include "interpret.h" #include "svalue.h" @@ -828,9 +828,9 @@ static void file_read(INT32 args) *! Check if there is data available to read, *! or wait some time for available data to read. *! - *! Returns @tt{1@} if there is data available to read, - *! @tt{0@} (zero) if there is no data available, and - *! @tt{-1@} if something went wrong. + *! Returns @expr{1@} if there is data available to read, + *! @expr{0@} (zero) if there is no data available, and + *! @expr{-1@} if something went wrong. *! *! @seealso *! @[errno()], @[read()] @@ -1534,7 +1534,7 @@ static void file_close(INT32 args) *! *! Open a file or fd. *! - *! If @[access] is not specified, it will default to @tt{00666@}. + *! If @[access] is not specified, it will default to @expr{00666@}. *! *! @seealso *! @[close()] @@ -1694,9 +1694,9 @@ static void file_open(INT32 args) *! *! @returns *! - *! Returns @tt{0@} (zero) and sets errno on failure. + *! Returns @expr{0@} (zero) and sets errno on failure. *! - *! Returns @tt{1@} on success. + *! Returns @expr{1@} on success. */ void file_sync(INT32 args) { @@ -1739,7 +1739,7 @@ void file_sync(INT32 args) *! otherwise it will be an absolute offset from the start of the file. *! *! @returns - *! Returns the new offset, or @tt{-1@} on failure. + *! Returns the new offset, or @expr{-1@} on failure. *! *! @note *! The arguments @[mult] and @[add] are considered obsolete, and @@ -1840,7 +1840,7 @@ static void file_tell(INT32 args) *! Truncates the file to the specified length @[length]. *! *! @returns - *! Returns @tt{1@} on success, and @tt{0@} (zero) on failure. + *! Returns @expr{1@} on success, and @expr{0@} (zero) on failure. *! *! @seealso *! @[open()] @@ -1894,7 +1894,7 @@ static void file_truncate(INT32 args) *! Get status for an open file. *! *! This function returns the same information as the function @[file_stat()], - *! but for the file it is called in. If file is not an open file, @tt{0@} + *! but for the file it is called in. If file is not an open file, @expr{0@} *! (zero) will be returned. Zero is also returned if file is a pipe or *! socket. *! @@ -2092,7 +2092,7 @@ struct object *file_make_object_from_fd(int fd, int mode, int guess) *! This function sets the internal buffer size of a socket or stream. *! *! The second argument allows you to set the read or write buffer by - *! specifying @tt{"r"@} or @tt{"w"@}. + *! specifying @expr{"r"@} or @expr{"w"@}. *! *! @note *! It is not guaranteed that this function actually does anything, @@ -2751,11 +2751,11 @@ static void file_set_keepalive(INT32 args) *! and failure with the close-callback or the read_oob-callback. *! *! @returns - *! Returns @tt{1@} on success, and @tt{0@} on failure. + *! Returns @expr{1@} on success, and @expr{0@} on failure. *! *! @note - *! In nonblocking mode @tt{0@} (zero) may be returned and @[errno()] set to - *! @tt{EWOULDBLOCK@} or @tt{WSAEWOULDBLOCK@}. This should not be regarded + *! In nonblocking mode @expr{0@} (zero) may be returned and @[errno()] set + *! to @tt{EWOULDBLOCK@} or @tt{WSAEWOULDBLOCK@}. This should not be regarded *! as a connection failure. */ static void file_connect_unix( INT32 args ) @@ -2811,11 +2811,11 @@ static void file_connect_unix( INT32 args ) *! and failure with the close-callback or the read_oob-callback. *! *! @returns - *! Returns @tt{1@} on success, and @tt{0@} on failure. + *! Returns @expr{1@} on success, and @expr{0@} on failure. *! *! @note - *! In nonblocking mode @tt{0@} (zero) may be returned and @[errno()] set to - *! @tt{EWOULDBLOCK@} or @tt{WSAEWOULDBLOCK@}. This should not be regarded + *! In nonblocking mode @expr{0@} (zero) may be returned and @[errno()] set + *! to @tt{EWOULDBLOCK@} or @tt{WSAEWOULDBLOCK@}. This should not be regarded *! as a connection failure. */ static void file_connect(INT32 args) @@ -2910,12 +2910,12 @@ static int isipnr(char *s) *! This function returns the remote or local address of a socket on the *! form "x.x.x.x port". *! - *! If the argument @[local] is not specified, or is @tt{0@} (zero), + *! If the argument @[local] is not specified, or is @expr{0@} (zero), *! the remote address will be returned. Otherwise, if @[local] is - *! @tt{1@}, the local address will be returned. + *! @expr{1@}, the local address will be returned. *! *! If the file is not a socket, not connected, or some other error - *! occurrs, @tt{0@} (zero) will be returned. + *! occurrs, @expr{0@} (zero) will be returned. *! *! @seealso *! @[connect()] diff --git a/src/modules/files/stat.c b/src/modules/files/stat.c index d3162637a8..4fbdb848d7 100644 --- a/src/modules/files/stat.c +++ b/src/modules/files/stat.c @@ -2,11 +2,11 @@ || 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: stat.c,v 1.26 2003/03/27 18:25:08 mast Exp $ +|| $Id: stat.c,v 1.27 2003/04/07 17:21:13 nilsson Exp $ */ #include "global.h" -RCSID("$Id: stat.c,v 1.26 2003/03/27 18:25:08 mast Exp $"); +RCSID("$Id: stat.c,v 1.27 2003/04/07 17:21:13 nilsson Exp $"); #include "fdlib.h" #include "interpret.h" #include "svalue.h" @@ -85,19 +85,19 @@ RCSID("$Id: stat.c,v 1.26 2003/03/27 18:25:08 mast Exp $"); *! of the above: *! @dl *! @item type - *! The type as a string, can be any of @tt{"reg"@}, - *! @tt{"dir"@}, @tt{"lnk"@}, @tt{"fifo"@}, @tt{"sock"@}, - *! @tt{"chr"@}, @tt{"blk"@}, and @tt{"unknown"@}. + *! The type as a string, can be any of @expr{"reg"@}, + *! @expr{"dir"@}, @expr{"lnk"@}, @expr{"fifo"@}, @expr{"sock"@}, + *! @expr{"chr"@}, @expr{"blk"@}, and @expr{"unknown"@}. *! @item mode_string *! The file mode encoded as a string in @tt{ls -l@} style, e.g. - *! @tt{"drwxr-xr-x"@}. + *! @expr{"drwxr-xr-x"@}. *! @enddl *! *! Note that some items might not exist or have meaningful values *! on some platforms. *! *! Additionally, the object may be initialized from or casted to an - *! @tt{array@} on the form of a 'traditional' LPC stat-array, and + *! @expr{array@} on the form of a 'traditional' LPC stat-array, and *! it's also possible to index the object directly with integers as *! if it were such an array. The stat-array has this format: *! @@ -122,8 +122,8 @@ RCSID("$Id: stat.c,v 1.26 2003/03/27 18:25:08 mast Exp $"); *! *! It's possible to modify the stat struct by assigning values to *! the items. They essentially work as variables, although some of - *! them affect others, e.g. setting @tt{isdir@} clears @tt{isreg@} - *! and setting @tt{mode_string@} changes many of the other items. + *! them affect others, e.g. setting @expr{isdir@} clears @expr{isreg@} + *! and setting @expr{mode_string@} changes many of the other items. */ /* Let's define these mode flags if they don't exist, so reading and @@ -302,9 +302,9 @@ static void stat_push_compat(INT_TYPE n) *! @item *! @[stat] is an object, typically another @[Stdio.Stat]. The *! stat info is copied from the object by getting the values of - *! @tt{mode@}, @tt{size@}, @tt{atime@}, @tt{mtime@}, @tt{ctime@}, - *! @tt{uid@}, @tt{gid@}, @tt{dev@}, @tt{ino@}, @tt{nlink@}, and - *! @tt{rdev@}. + *! @expr{mode@}, @expr{size@}, @expr{atime@}, @expr{mtime@}, + *! @expr{ctime@}, @expr{uid@}, @expr{gid@}, @expr{dev@}, @expr{ino@}, + *! @expr{nlink@}, and @expr{rdev@}. *! @item *! @[stat] is a seven element array on the 'traditional' LPC *! stat-array form (see the class doc). diff --git a/src/modules/files/udp.c b/src/modules/files/udp.c index 299db03b0a..97112b6944 100644 --- a/src/modules/files/udp.c +++ b/src/modules/files/udp.c @@ -2,7 +2,7 @@ || 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: udp.c,v 1.42 2003/03/12 09:58:18 agehall Exp $ +|| $Id: udp.c,v 1.43 2003/04/07 17:21:13 nilsson Exp $ */ #define NO_PIKE_SHORTHAND @@ -10,7 +10,7 @@ #include "file_machine.h" -RCSID("$Id: udp.c,v 1.42 2003/03/12 09:58:18 agehall Exp $"); +RCSID("$Id: udp.c,v 1.43 2003/04/07 17:21:13 nilsson Exp $"); #include "fdlib.h" #include "interpret.h" #include "svalue.h" @@ -268,7 +268,7 @@ static void udp_bind(INT32 args) *! broadcast address. *! *! @returns - *! Returns @tt{1@} on success, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} on success, @expr{0@} (zero) otherwise. *! *! @note *! This is normally only avalable to root users. @@ -292,7 +292,7 @@ void udp_enable_broadcast(INT32 args) *! Check for data and wait max. @[timeout] seconds. *! *! @returns - *! Returns @tt{1@} if data are ready, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if data are ready, @expr{0@} (zero) otherwise. */ void udp_wait(INT32 args) { @@ -666,7 +666,7 @@ static void udp_set_blocking(INT32 args) *! number for the remote machine. *! *! @returns - *! Returns @tt{1@} on success, @tt{0@} (zero) otherwise. + *! Returns @expr{1@} on success, @expr{0@} (zero) otherwise. *! *! @note *! If the socket is in nonblocking mode, you have to wait diff --git a/src/modules/system/passwords.c b/src/modules/system/passwords.c index cfcd69f949..fa24090401 100644 --- a/src/modules/system/passwords.c +++ b/src/modules/system/passwords.c @@ -2,7 +2,7 @@ || 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: passwords.c,v 1.40 2003/04/02 20:14:29 nilsson Exp $ +|| $Id: passwords.c,v 1.41 2003/04/07 17:21:36 nilsson Exp $ */ /* @@ -27,7 +27,7 @@ #include "system_machine.h" #include "system.h" -RCSID("$Id: passwords.c,v 1.40 2003/04/02 20:14:29 nilsson Exp $"); +RCSID("$Id: passwords.c,v 1.41 2003/04/07 17:21:36 nilsson Exp $"); #include "module_support.h" #include "interpret.h" @@ -422,7 +422,7 @@ void f_getpwuid(INT32 args) *! using the systemfunction @tt{setpwent(3)@}. *! *! @returns - *! Always @tt{0@} (zero) + *! Always @expr{0@} (zero) *! *! @seealso *! @[get_all_users()] @@ -450,7 +450,7 @@ void f_setpwent(INT32 args) *! systemfunction @tt{endpwent(3)@}. *! *! @returns - *! Always @tt{0@} (zero) + *! Always @expr{0@} (zero) *! *! @seealso *! @[get_all_users()] diff --git a/src/modules/system/system.c b/src/modules/system/system.c index 93a5364ea3..804a182351 100644 --- a/src/modules/system/system.c +++ b/src/modules/system/system.c @@ -2,7 +2,7 @@ || 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: system.c,v 1.141 2003/03/03 16:41:48 grubba Exp $ +|| $Id: system.c,v 1.142 2003/04/07 17:21:36 nilsson Exp $ */ /* @@ -20,7 +20,7 @@ #include "system_machine.h" #include "system.h" -RCSID("$Id: system.c,v 1.141 2003/03/03 16:41:48 grubba Exp $"); +RCSID("$Id: system.c,v 1.142 2003/04/07 17:21:36 nilsson Exp $"); #ifdef HAVE_WINSOCK_H #include <winsock.h> #endif @@ -1025,8 +1025,8 @@ void f_setsid(INT32 args) *! @endint *! *! @returns - *! Returns @tt{1@} if this process currently is capable of dumping core, - *! and @tt{0@} (zero) if not. + *! Returns @expr{1@} if this process currently is capable of dumping core, + *! and @expr{0@} (zero) if not. *! *! @note *! This function is currently only available on some versions of Linux. diff --git a/src/operators.c b/src/operators.c index ff6b3a9b15..2952b5f3ee 100644 --- a/src/operators.c +++ b/src/operators.c @@ -2,12 +2,12 @@ || 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: operators.c,v 1.173 2003/04/01 18:11:09 nilsson Exp $ +|| $Id: operators.c,v 1.174 2003/04/07 17:28:55 nilsson Exp $ */ #include "global.h" #include <math.h> -RCSID("$Id: operators.c,v 1.173 2003/04/01 18:11:09 nilsson Exp $"); +RCSID("$Id: operators.c,v 1.174 2003/04/07 17:28:55 nilsson Exp $"); #include "interpret.h" #include "svalue.h" #include "multiset.h" @@ -65,8 +65,8 @@ PMOD_EXPORT void ID(INT32 args) \ *! Inequality operator. *! *! @returns - *! Returns @tt{0@} (zero) if all the arguments are equal, and - *! @tt{1@} otherwise. + *! Returns @expr{0@} (zero) if all the arguments are equal, and + *! @expr{1@} otherwise. *! *! This is the inverse of @[`==()]. *! @@ -85,8 +85,8 @@ PMOD_EXPORT void f_ne(INT32 args) *! Equality operator. *! *! @returns - *! Returns @tt{1@} if all the arguments are equal, and - *! @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if all the arguments are equal, and + *! @expr{0@} (zero) otherwise. *! *! @seealso *! @[`!=()] @@ -98,8 +98,8 @@ COMPARISON(f_eq,"`==", is_eq) *! Less than operator. *! *! @returns - *! Returns @tt{1@} if the arguments are strictly increasing, and - *! @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if the arguments are strictly increasing, and + *! @expr{0@} (zero) otherwise. *! *! @seealso *! @[`<=()], @[`>()], @[`>=()] @@ -111,8 +111,8 @@ COMPARISON(f_lt,"`<" , is_lt) *! Less or equal operator. *! *! @returns - *! Returns @tt{1@} if the arguments are not strictly decreasing, and - *! @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if the arguments are not strictly decreasing, and + *! @expr{0@} (zero) otherwise. *! *! This is the inverse of @[`>()]. *! @@ -126,8 +126,8 @@ COMPARISON(f_le,"`<=",!is_gt) *! Greater than operator. *! *! @returns - *! Returns @tt{1@} if the arguments are strictly decreasing, and - *! @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if the arguments are strictly decreasing, and + *! @expr{0@} (zero) otherwise. *! *! @seealso *! @[`<()], @[`<=()], @[`>=()] @@ -139,8 +139,8 @@ COMPARISON(f_gt,"`>" , is_gt) *! Greater or equal operator. *! *! @returns - *! Returns @tt{1@} if the arguments are not strictly increasing, and - *! @tt{0@} (zero) otherwise. + *! Returns @expr{1@} if the arguments are not strictly increasing, and + *! @expr{0@} (zero) otherwise. *! *! This is the inverse of @[`<()]. *! @@ -217,7 +217,7 @@ COMPARISON(f_ge,"`>=",!is_lt) *! @note *! In Pike 7.0 and earlier the addition order was unspecified. *! - *! If @[arg1] is @tt{UNDEFINED@} it will behave as the empty + *! If @[arg1] is @expr{UNDEFINED@} it will behave as the empty *! array/mapping/multiset if needed. This behaviour was new *! in Pike 7.0. *! @@ -1079,10 +1079,10 @@ PMOD_EXPORT void o_subtract(void) *! If there are more than two arguments the result will be: *! @expr{`-(`-(@[arg1], @[arg2]), @@@[extras])@}. *! - *! If @[arg1] is an object that overloads @tt{`-()@}, that function will + *! If @[arg1] is an object that overloads @expr{`-()@}, that function will *! be called with @[arg2] as the single argument. *! - *! If @[arg2] is an object that overloads @tt{``-()@}, that function will + *! If @[arg2] is an object that overloads @expr{``-()@}, that function will *! be called with @[arg1] as the single argument. *! *! Otherwise the result will be as follows: @@ -2924,10 +2924,10 @@ PMOD_EXPORT void o_not(void) *! If @[arg] is an object that implements @[lfun::`!()], that function *! will be called. *! - *! If @[arg] is @tt{0@} (zero), a destructed object, or a function in a - *! destructed object, @tt{1@} will be returned. + *! If @[arg] is @expr{0@} (zero), a destructed object, or a function in a + *! destructed object, @expr{1@} will be returned. *! - *! Otherwise @tt{0@} (zero) will be returned. + *! Otherwise @expr{0@} (zero) will be returned. *! *! @seealso *! @[`==()], @[`!=()], @[lfun::`!()] @@ -3197,10 +3197,10 @@ PMOD_EXPORT void o_range(void) *! with @[index] will be returned. *! @type mapping *! If @[index] exists in @[arg] the corresponding value will be - *! returned. Otherwise @tt{UNDEFINED@} will be returned. + *! returned. Otherwise @expr{UNDEFINED@} will be returned. *! @type multiset - *! If @[index] exists in @[arg], @tt{1@} will be returned. - *! Otherwise @tt{UNDEFINED@} will be returned. + *! If @[index] exists in @[arg], @expr{1@} will be returned. + *! Otherwise @expr{UNDEFINED@} will be returned. *! @type string *! The character (int) at index @[index] in @[arg] will be returned. *! @type program @@ -3269,10 +3269,10 @@ PMOD_EXPORT void f_index(INT32 args) *! will be returned. *! @type mapping *! If @[index] exists in @[arg] the corresponding value will be - *! returned. Otherwise @tt{UNDEFINED@} will be returned. + *! returned. Otherwise @expr{UNDEFINED@} will be returned. *! @type multiset - *! If @[index] exists in @[arg], @tt{1@} will be returned. - *! Otherwise @tt{UNDEFINED@} will be returned. + *! If @[index] exists in @[arg], @expr{1@} will be returned. + *! Otherwise @expr{UNDEFINED@} will be returned. *! @type program *! The non-static (ie public) constant symbol @[index] will be *! looked up in @[arg]. @@ -3317,7 +3317,7 @@ PMOD_EXPORT void f_arrow(INT32 args) *! @type array|mapping *! Index @[index] in @[arg] will be assigned @[val]. *! @type multiset - *! If @[val] is @tt{0@} (zero), one occurrance of @[index] in + *! If @[val] is @expr{0@} (zero), one occurrance of @[index] in *! @[arg] will be removed. Otherwise @[index] will be added *! to @[arg] if it is not already there. *! @endmixed @@ -3366,7 +3366,7 @@ PMOD_EXPORT void f_index_assign(INT32 args) *! @type array|mapping *! Index @[index] in @[arg] will be assigned @[val]. *! @type multiset - *! If @[val] is @tt{0@} (zero), one occurrance of @[index] in + *! If @[val] is @expr{0@} (zero), one occurrance of @[index] in *! @[arg] will be removed. Otherwise @[index] will be added *! to @[arg] if it is not already there. *! @endmixed diff --git a/src/pike_search.c b/src/pike_search.c index 9b31011dc2..a852f74aea 100644 --- a/src/pike_search.c +++ b/src/pike_search.c @@ -2,7 +2,7 @@ || 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: pike_search.c,v 1.14 2003/04/02 19:22:43 mast Exp $ +|| $Id: pike_search.c,v 1.15 2003/04/07 17:28:55 nilsson Exp $ */ /* New memory searcher functions */ @@ -210,7 +210,7 @@ PMOD_EXPORT char *my_memmem(char *needle, *! offset @[start]. *! *! @returns - *! Returns the offset where a match was found, or @tt{-1@} on + *! Returns the offset where a match was found, or @expr{-1@} on *! failure. *! *! @seealso diff --git a/src/post_modules/_ADT/circular_list.cmod b/src/post_modules/_ADT/circular_list.cmod index bce145f503..3d58b49d94 100644 --- a/src/post_modules/_ADT/circular_list.cmod +++ b/src/post_modules/_ADT/circular_list.cmod @@ -2,7 +2,7 @@ || 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: circular_list.cmod,v 1.4 2003/04/07 16:11:49 nilsson Exp $ +|| $Id: circular_list.cmod,v 1.5 2003/04/07 17:27:11 nilsson Exp $ */ #include "global.h" @@ -388,7 +388,7 @@ PIKECLASS CircularList /*! @decl int _search(mixed value, void|int start) *! Search the list for a specific value. Return the index of the first - *! value that is equal to @[value]. If no value was found @tt{UNDEFINED@} + *! value that is equal to @[value]. If no value was found @expr{UNDEFINED@} *! is returned insted *! *! @param value @@ -399,7 +399,7 @@ PIKECLASS CircularList *! @[start]. *! *! @returns - *! Returns the index of the found value or @tt{UNDEFINED@}. + *! Returns the index of the found value or @expr{UNDEFINED@}. *! *! @throws *! An error if the start is out of range. @@ -676,7 +676,7 @@ PIKECLASS CircularList /*! @decl int(0..1) is_empty() *! *! @returns - *! Returns @tt{1@} if the list is empty otherwise @tt{0@}. + *! Returns @expr{1@} if the list is empty otherwise @expr{0@}. */ PIKEFUN int is_empty() diff --git a/src/post_modules/_ADT/sequence.cmod b/src/post_modules/_ADT/sequence.cmod index 999b0de4e1..cd47a4be10 100644 --- a/src/post_modules/_ADT/sequence.cmod +++ b/src/post_modules/_ADT/sequence.cmod @@ -2,7 +2,7 @@ || 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: sequence.cmod,v 1.5 2003/04/05 11:59:39 grubba Exp $ +|| $Id: sequence.cmod,v 1.6 2003/04/07 17:27:11 nilsson Exp $ */ #include "global.h" @@ -348,7 +348,7 @@ PIKECLASS Sequence /*! @decl void _search(mixed value, void|int start) *! Search the sequence for a specific value. Return the index of the first - *! value that is equal to @[value]. If no value was found @tt{UNDEFINED@} + *! value that is equal to @[value]. If no value was found @expr{UNDEFINED@} *! is returned insted *! *! @param value @@ -359,7 +359,7 @@ PIKECLASS Sequence *! @[start]. *! *! @returns - *! Returns the index of the found value or @tt{UNDEFINED@}. + *! Returns the index of the found value or @expr{UNDEFINED@}. */ PIKEFUN int _search(mixed value, void|int start) @@ -485,7 +485,7 @@ PIKECLASS Sequence /*! @decl int(0..1) is_empty() *! *! @returns - *! Returns @tt{1@} if the sequence is empty otherwise @tt{0@}. + *! Returns @expr{1@} if the sequence is empty otherwise @expr{0@}. */ PIKEFUN int is_empty() diff --git a/src/program.c b/src/program.c index cfa599f6af..fd3148851d 100644 --- a/src/program.c +++ b/src/program.c @@ -2,11 +2,11 @@ || 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.497 2003/04/02 19:22:44 mast Exp $ +|| $Id: program.c,v 1.498 2003/04/07 17:28:55 nilsson Exp $ */ #include "global.h" -RCSID("$Id: program.c,v 1.497 2003/04/02 19:22:44 mast Exp $"); +RCSID("$Id: program.c,v 1.498 2003/04/07 17:28:55 nilsson Exp $"); #include "program.h" #include "object.h" #include "dynamic_buffer.h" @@ -264,8 +264,8 @@ static char *raw_lfun_types[] = { *! @note *! Although these functions are called from outside the object *! they exist in, they will still be used even if they are - *! declared @tt{static@}. It is infact recommended to declare - *! them @tt{static@}, since that will hinder them being used + *! declared @expr{static@}. It is infact recommended to declare + *! them @expr{static@}, since that will hinder them being used *! for other purposes. *! *! @seealso @@ -485,7 +485,7 @@ static char *raw_lfun_types[] = { *! *! @returns *! Returns non-zero if the object should be evaluated as false, - *! and @tt{0@} (zero) otherwise. + *! and @expr{0@} (zero) otherwise. *! *! @seealso *! @[predef::`!()] @@ -691,7 +691,7 @@ static char *raw_lfun_types[] = { *! @endstring *! *! @returns - *! Expected to return @tt{1@} if the object is to be regarded as a + *! Expected to return @expr{1@} if the object is to be regarded as a *! simulation of the type specified by @[basic_type]. *! *! @note @@ -707,7 +707,7 @@ static char *raw_lfun_types[] = { *! This method is called by @[predef::sprintf()] to print objects. If it is *! not present, printing of the object will not be supported for any *! conversion-type except for the @tt{%O@}-conversion-type, which - *! will output @tt{"object"@}. + *! will output @expr{"object"@}. *! *! @param conversion_type *! One of: @@ -799,8 +799,8 @@ static char *raw_lfun_types[] = { *! Should return an object that implements the iterator API: *! @dl *! @item - *! @[lfun::`!()] should return @tt{0@} (zero) when not at end of stream, - *! and @tt{1@} at end of stream. + *! @[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 @@ -845,9 +845,9 @@ static char *raw_lfun_types[] = { *! be fetched. *! *! @returns - *! Returns the default module, or @tt{0@} (zero). + *! Returns the default module, or @expr{0@} (zero). *! - *! If @tt{0@} (zero) is returned the compiler use the mapping + *! If @expr{0@} (zero) is returned the compiler use the mapping *! returned by @[all_constants()] as fallback. *! *! @seealso diff --git a/src/security.c b/src/security.c index 83afa1ef86..43a4dda73a 100644 --- a/src/security.c +++ b/src/security.c @@ -2,7 +2,7 @@ || 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: security.c,v 1.41 2003/04/01 18:11:09 nilsson Exp $ +|| $Id: security.c,v 1.42 2003/04/07 17:28:56 nilsson Exp $ */ #include "global.h" @@ -81,13 +81,13 @@ static void restore_creds(struct object *creds) *! Call with credentials. *! *! Sets the current credentials to @[creds], and calls - *! @expr{@[func](@@@[args])@}. If @[creds] is @tt{0@} (zero), the + *! @expr{@[func](@@@[args])@}. If @[creds] is @expr{0@} (zero), the *! credentials from the current object will be used. *! *! @note *! The current creds or the current object must have the allow bit - *! @tt{BIT_SECURITY@} set to allow calling with @[creds] other than - *! @tt{0@} (zero). + *! @[BIT_SECURITY] set to allow calling with @[creds] other than + *! @expr{0@} (zero). */ static void f_call_with_creds(INT32 args) { @@ -151,7 +151,7 @@ static void f_call_with_creds(INT32 args) *! Get the current credentials *! *! Returns the credentials that are currently active. - *! Returns @tt{0@} (zero) if no credentials are active. + *! Returns @expr{0@} (zero) if no credentials are active. *! *! @seealso *! @[call_with_creds()] @@ -178,7 +178,7 @@ static void f_get_current_creds(INT32 args) *! Get the default credentials. *! *! Returns the default credentials object if it has been set. - *! Returns @tt{0@} (zero) if it has not been set. + *! Returns @expr{0@} (zero) if it has not been set. *! *! @seealso *! @[set_default_creds()] @@ -198,7 +198,7 @@ static void get_default_creds(INT32 args) *! *! @note *! The current creds must have the allow bit - *! @tt{BIT_SECURITY@} set. + *! @[BIT_SECURITY] set. *! *! @seealso *! @[get_default_creds()] @@ -224,7 +224,7 @@ static void set_default_creds(INT32 args) *! *! @note *! The current creds must have the allow bit - *! @tt{BIT_SECURITY@} set. + *! @[BIT_SECURITY] set. */ static void creds_create(INT32 args) { @@ -283,7 +283,7 @@ static void creds_get_data_bits(INT32 args) *! *! @note *! To perform this operation the current credentials needs to have the bit - *! @tt{BIT_SECURITY@} set, or have the same user as the old credentials + *! @[BIT_SECURITY] set, or have the same user as the old credentials *! and not change the user by performing the operation. */ static void creds_apply(INT32 args) @@ -313,7 +313,7 @@ static void creds_apply(INT32 args) *! *! Get the credentials from @[o]. *! - *! Returns @tt{0@} if @[o] does not have any credentials. + *! Returns @expr{0@} if @[o] does not have any credentials. */ static void f_get_object_creds(INT32 args) { diff --git a/src/signal_handler.c b/src/signal_handler.c index ac320750b2..091d439443 100644 --- a/src/signal_handler.c +++ b/src/signal_handler.c @@ -2,7 +2,7 @@ || 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: signal_handler.c,v 1.261 2003/04/06 18:36:17 grubba Exp $ +|| $Id: signal_handler.c,v 1.262 2003/04/07 17:28:56 nilsson Exp $ */ #include "global.h" @@ -26,7 +26,7 @@ #include "main.h" #include <signal.h> -RCSID("$Id: signal_handler.c,v 1.261 2003/04/06 18:36:17 grubba Exp $"); +RCSID("$Id: signal_handler.c,v 1.262 2003/04/07 17:28:56 nilsson Exp $"); #ifdef HAVE_PASSWD_H # include <passwd.h> @@ -2396,7 +2396,7 @@ static void internal_add_limit( struct perishables *storage, *! and @[getgrgid] for more info.) *! *! @member int(0..1)|object(Stdio.File) "setsid" - *! Set this to @tt{1@} to create a new session group. + *! Set this to @expr{1@} to create a new session group. *! It is also possible to set it to a File object, in which *! case a new session group will be created with this file *! as the controlling terminal. @@ -2430,7 +2430,7 @@ static void internal_add_limit( struct perishables *storage, *! *! @member array(Stdio.File|int(0..0)) "fds" *! This parameter allows you to map files to filedescriptors 3 and - *! up. The file @tt{fds[0]@} will be remapped to fd 3 in the new + *! up. The file @expr{fds[0]@} will be remapped to fd 3 in the new *! process, etc. *! *! @member mapping(string:limit_value) "rlimit" @@ -2495,9 +2495,9 @@ static void internal_add_limit( struct perishables *storage, *! noticeably slower using a string instead of an integer; if maximum *! performance is an issue, please use integers. *! - *! The modifiers @tt{"fds"@}, @tt{"uid"@}, @tt{"gid"@}, @tt{"nice"@}, - *! @tt{"noinitgroups"@}, @tt{"setgroups"@}, @tt{"keep_signals"@} - *! and @tt{"rlimit"@} only exist on unix. + *! The modifiers @expr{"fds"@}, @expr{"uid"@}, @expr{"gid"@}, + *! @expr{"nice"@}, @expr{"noinitgroups"@}, @expr{"setgroups"@}, + *! @expr{"keep_signals"@} and @expr{"rlimit"@} only exist on unix. */ /*! @endclass */ @@ -4303,7 +4303,7 @@ static void f_getpid(INT32 args) *! @[alarm()] arranges for a SIGALRM signal to be delivered to the *! process in @[seconds] seconds. *! - *! If @[seconds] is @tt{0@} (zero), no new alarm will be scheduled. + *! If @[seconds] is @expr{0@} (zero), no new alarm will be scheduled. *! *! Any previous alarms will in any case be canceled. *! @@ -4349,7 +4349,7 @@ static void f_alarm(INT32 args) *! @[alarm()] arranges for a SIGALRM signal to be delivered to the *! process in @[useconds] microseconds. *! - *! If @[useconds] is @tt{0@} (zero), no new alarm will be scheduled. + *! If @[useconds] is @expr{0@} (zero), no new alarm will be scheduled. *! *! Any previous alarms will in any case be canceled. *! -- GitLab