Branch: Tag:

2003-04-07

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

Use @expr where more approrpiate than @tt

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

27:   //!   //! @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:   //!   //! @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:   //! @[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:   //! 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:   //! 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:   //! 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:   //! 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:   //! @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()]