Log of autodoc.git/autodoc.xml

2000-02-29

2000-02-29 20:33:48 by David Hedbor <david@hedbor.org>

e76a11a6f88be5909b6066edd567d17543e390a2 (342 lines) (+342/-0) ^{[

Show
| Annotate

]}
Branch: 8.0

First submit of Gettext module

Rev: src/modules/Gettext/.cvsignore:1.1
Rev: src/modules/Gettext/Makefile.in:1.1
Rev: src/modules/Gettext/acconfig.h:1.1
Rev: src/modules/Gettext/configure.in:1.1
Rev: src/modules/Gettext/gettext.c:1.1

1838: </docgroup> </class> </module> + <module name='Gettext'> + <doc> + <text> + + This module enables access to localization functions from within Pike. + + </text> + + </doc> + <docgroup homogen-name='bindtextdomain' homogen-type='method'> + <method name='bindtextdomain'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='domainname'><type> + <or><string/><void/></or></type></argument> + <argument name='string|voiddirname'><type> + <object resolved='predef::Gettext.bindtextdomain'/></type></argument> + + </arguments> + </method><doc> + <text> + The bindtextdomain() function binds the path predicate for a + message domain domainname to the value contained in dirname. If + domainname is a non-empty string and has not been bound + previously, bindtextdomain() binds domainname with dirname. + + If domainname is a non-empty string and has been bound previously, + bindtextdomain() replaces the old binding with dirname. The dirname + argument can be an absolute or relative pathname being resolved when + gettext(), dgettext(), or dcgettext() are called. If domainname is + null pointer or an empty string, bindtextdomain() returns 0. User + defined domain names cannot begin with the string SYS_. Domain names + beginning with this string are reserved for system use. + + The return value from bindtextdomain() is a string containing + dirname or the directory binding associated with domainname if + dirname is void. If no binding is found, the default locale + path is returned. If domainname is void or an empty string, + bindtextdomain() takes no action and returns a 0. + + </text> + <group> + <param name='domainname'/> + <text>The domain to query or bind a path to.</text></group> + <group> + <param name='dirname'/> + <text>The directory name to bind to the choosen domain.</text></group> + <group><seealso/><text> + <ref resolved='predef::Gettext.textdomain'>textdomain</ref>, <ref resolved='predef::Gettext.gettext'>gettext</ref>, <ref resolved='predef::Gettext.dgettext'>dgettext</ref>, <ref resolved='predef::Gettext.dcgettext'>dcgettext</ref>, <ref resolved='predef::Gettext.setlocale'>setlocale</ref>, <ref resolved='predef::Gettext.localeconv'>localeconv</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='dcgettext' homogen-type='method'> + <method name='dcgettext'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='domain'><type><string/></type></argument> + <argument name='stringmsg'><type> + <object resolved='predef::Gettext.dcgettext'/></type></argument> + <argument name='intcategory'><type> + <object resolved='predef::Gettext.dcgettext'/></type></argument> + + </arguments> + </method><doc> + <text> + Return a translated version of msg within the context of the + specified domain and current locale for the specified + category. Calling dcgettext with category + Locale.Gettext.LC_MESSAGES gives the same result as dgettext. + + If there is not translation available, msg is returned. + + </text> + <group> + <param name='domain'/> + <text>The domain to lookup the message in.</text></group> + <group> + <param name='msg'/> + <text>The message to translate.</text></group> + <group> + <param name='category'/> + <text>The category which locale should be used.</text></group> + <group><seealso/><text> + <ref resolved='predef::Gettext.bindtextdomain'>bindtextdomain</ref>, <ref resolved='predef::Gettext.textdomain'>textdomain</ref>, <ref resolved='predef::Gettext.gettext'>gettext</ref>, <ref resolved='predef::Gettext.dgettext'>dgettext</ref>, <ref resolved='predef::Gettext.setlocale'>setlocale</ref>, <ref resolved='predef::Gettext.localeconv'>localeconv</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='dgettext' homogen-type='method'> + <method name='dgettext'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='domain'><type><string/></type></argument> + <argument name='stringmsg'><type> + <object resolved='predef::Gettext.dgettext'/></type></argument> + + </arguments> + </method><doc> + <text> + Return a translated version of msg within the context + of the specified domain and current locale. + + If there is not translation available, msg is returned. + + </text> + <group> + <param name='domain'/> + <text>The domain to lookup the message in.</text></group> + <group> + <param name='msg'/> + <text>The message to translate.</text></group> + <group><seealso/><text> + <ref resolved='predef::Gettext.bindtextdomain'>bindtextdomain</ref>, <ref resolved='predef::Gettext.textdomain'>textdomain</ref>, <ref resolved='predef::Gettext.gettext'>gettext</ref>, <ref resolved='predef::Gettext.dcgettext'>dcgettext</ref>, <ref resolved='predef::Gettext.setlocale'>setlocale</ref>, <ref resolved='predef::Gettext.localeconv'>localeconv</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='gettext' homogen-type='method'> + <method name='gettext'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='msg'><type><string/></type></argument> + + </arguments> + </method><doc> + <text> + Return a translated version of msg within the context + of the current domain and locale. + + If there is not translation available, msg is returned. + </text> + <group> + <param name='msg'/> + <text>The message to translate.</text></group> + <group><seealso/><text> + <ref resolved='predef::Gettext.bindtextdomain'>bindtextdomain</ref>, <ref resolved='predef::Gettext.textdomain'>textdomain</ref>, <ref resolved='predef::Gettext.dgettext'>dgettext</ref>, <ref resolved='predef::Gettext.dcgettext'>dcgettext</ref>, <ref resolved='predef::Gettext.setlocale'>setlocale</ref>, <ref resolved='predef::Gettext.localeconv'>localeconv</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='localeconv' homogen-type='method'> + <method name='localeconv'> + <returntype> + <object>mapping </object></returntype> + <arguments> + </arguments> + </method><doc> + <text> + The localeconv() function returns a mapping with settings for + the current locale. This mapping contains all values + associated with the locale categories LC_NUMERIC and + LC_MONETARY. + + string decimal_point: + The decimal-point character used to format + non-monetary quantities. + + string thousands_sep: + The character used to separate groups of digits to + the left of the decimal-point character in + formatted non-monetary quantities. + + string int_curr_symbol: + The international currency symbol applicable to + the current locale, left-justified within a + four-character space-padded field. The character + sequences should match with those specified in ISO + 4217 Codes for the Representation of Currency and + Funds. + + string currency_symbol: + The local currency symbol applicable to the + current locale. + + string mon_decimal_point: + The decimal point used to format monetary quantities. + + string mon_thousands_sep: + The separator for groups of digits to the left of + the decimal point in formatted monetary quantities. + + string positive_sign: + The string used to indicate a non-negative-valued + formatted monetary quantity. + + string negative_sign: + The string used to indicate a negative-valued + formatted monetary quantity. + + int int_frac_digits: + The number of fractional digits (those to the + right of the decimal point) to be displayed in an + internationally formatted monetary quantity. + + int frac_digits: + The number of fractional digits (those to the + right of the decimal point) to be displayed in a + formatted monetary quantity. + + int p_cs_precedes: + Set to 1 or 0 if the currency_symbol respectively + precedes or succeeds the value for a non-negative + formatted monetary quantity. + + int p_sep_by_space: + Set to 1 or 0 if the currency_symbol respectively + is or is not separated by a space from the value + for a non-negative formatted monetary quantity. + + int n_cs_precedes: + Set to 1 or 0 if the currency_symbol respectively + precedes or succeeds the value for a negative + formatted monetary quantity. + + int n_sep_by_space: + Set to 1 or 0 if the currency_symbol respectively + is or is not separated by a space from the value + for a negative formatted monetary quantity. + + int p_sign_posn: + Set to a value indicating the positioning of the + positive_sign for a non-negative formatted + monetary quantity. The value of p_sign_posn is + interpreted according to the following: + + 0 - Parentheses surround the quantity and + currency_symbol. + + 1 - The sign string precedes the quantity and + currency_symbol. + + 2 - The sign string succeeds the quantity + and currency_symbol. + + 3 - The sign string immediately precedes the + currency_symbol. + + 4 - The sign string immediately succeeds the + currency_symbol. + + int n_sign_posn: + Set to a value indicating the positioning of the + negative_sign for a negative formatted monetary + quantity. The value of n_sign_posn is interpreted + according to the rules described under p_sign_posn. + </text> + + </doc> + </docgroup> + <docgroup homogen-name='setlocale' homogen-type='method'> + <method name='setlocale'> + <returntype> + <object>int </object></returntype> + <arguments><argument name='category'><type><int/></type></argument> + <argument name='stringlocale'><type> + <object resolved='predef::Gettext.setlocale'/></type></argument> + + </arguments> + </method><doc> + <text> + The setlocale() function is used to set the program's + current locale. If locale is "C" or "POSIX", the current + locale is set to the portable locale. + + If locale is "", the locale is set to the default locale which + is selected from the environment variable LANG. + + The argument category determines which functions are + influenced by the new locale: + + Locale.Gettext.LC_ALL for all of the locale. + + Locale.Gettext.LC_COLLATE for the functions strcoll() and + strxfrm() (used by pike, but not directly accessible). + + Locale.Gettext.LC_CTYPE for the character classification and + conversion routines. + + Locale.Gettext.LC_MONETARY for localeconv(). + + Locale.Gettext.LC_NUMERIC for the decimal character. + + Locale.Gettext.LC_TIME for strftime() (currently not accessible + from Pike). + + </text> + <group> + <param name='category'/> + <text>The category in which to set the locale.</text></group> + <group> + <param name='locale'/> + <text>The locale to change to</text></group> + <group><returns/><text> + 1 if the locale setting successed, 0 for failure + </text></group> + <group><seealso/><text> + <ref resolved='predef::Gettext.bindtextdomain'>bindtextdomain</ref>, <ref resolved='predef::Gettext.textdomain'>textdomain</ref>, <ref resolved='predef::Gettext.gettext'>gettext</ref>, <ref resolved='predef::Gettext.dgettext'>dgettext</ref>, <ref resolved='predef::Gettext.dcgettext'>dcgettext</ref>, <ref resolved='predef::Gettext.localeconv'>localeconv</ref></text></group> + + </doc> + </docgroup> + <docgroup homogen-name='textdomain' homogen-type='method'> + <method name='textdomain'> + <returntype> + <object>string </object></returntype> + <arguments><argument name='domain|void'><type><string/></type></argument> + + </arguments> + </method><method name='textdomain'> + <returntype> + <object>string </object></returntype> + <arguments><argument/> + + </arguments> + </method><doc> + <text> + The textdomain() function sets or queries the name of the + current domain of the active LC_MESSAGES locale category. The + domainname argument is a string that can contain only the + characters allowed in legal filenames. + + The domainname argument is the unique name of a domain on the + system. If there are multiple versions of the same domain on + one system, namespace collisions can be avoided by using + bindtextdomain(). If textdomain() is not called, a default + domain is selected. The setting of domain made by the last + valid call to textdomain() remains valid across subsequent + calls to setlocale, and gettext(). + + The normal return value from textdomain() is a string + containing the current setting of the domain. If domainname is + void, textdomain() returns a string containing the current + domain. If textdomain() was not previously called and + domainname is void, the name of the default domain is + returned. + </text> + <group> + <param name='domainname'/> + <text>The name of the domain to be made the current domain.</text></group> + <group><seealso/><text> + <ref resolved='predef::Gettext.bindtextdomain'>bindtextdomain</ref>, <ref resolved='predef::Gettext.gettext'>gettext</ref>, <ref resolved='predef::Gettext.dgettext'>dgettext</ref>, <ref resolved='predef::Gettext.dcgettext'>dcgettext</ref>, <ref resolved='predef::Gettext.setlocale'>setlocale</ref>, <ref resolved='predef::Gettext.localeconv'>localeconv</ref></text></group> + + </doc> + </docgroup> + </module> <module name='Gmp'> <class name='mpz'> <doc placeholder='true'>

autodoc.git/ autodoc.xml

2000-02-29

2000-02-29 20:33:48 by David Hedbor <david@hedbor.org>