Branch: Tag:

2001-04-27

2001-04-27 13:41:35 by Henrik Grubbström (Grubba) <grubba@grubba.org>

Autodoc mk II markup fixes.

Rev: lib/modules/ADT.pmod/Table.pmod:1.20
Rev: lib/modules/Crypto/randomness.pmod:1.19
Rev: lib/modules/Function.pmod:1.5
Rev: lib/modules/Geography.pmod/Countries.pmod:1.12
Rev: lib/modules/Getopt.pmod:1.13
Rev: lib/modules/Locale.pmod/module.pmod:1.11
Rev: lib/modules/Parser.pmod/module.pmod:1.6
Rev: lib/modules/Protocols.pmod/DNS.pmod:1.59
Rev: lib/modules/Protocols.pmod/HTTP.pmod/module.pmod:1.24
Rev: lib/modules/Protocols.pmod/Line.pmod:1.16
Rev: lib/modules/Protocols.pmod/LysKOM.pmod/Connection.pike:1.8
Rev: lib/modules/Protocols.pmod/LysKOM.pmod/Request.pmod:1.9
Rev: lib/modules/Protocols.pmod/TELNET.pmod:1.16
Rev: lib/modules/Sql.pmod/Sql.pike:1.48
Rev: lib/modules/Stdio.pmod/module.pmod:1.113
Rev: lib/modules/_Image.pmod/module.pmod:1.18

46:    ({"AQ","TF","HM"}),   ]);    + //! All known countries.   array(Country) countries=   ({    Country("AC","Ascension"),
307:    Country("ZW","Zimbabwe"),   });    - //! module Geography - //! submodule Countries - //! subclass Country -  + //! Country   class Country   { - //! variable string iso2 +     //! ISO 2-character code aka domain name -  +     string iso2; // iso-2-character-code aka domain name    - //! variable string name - //! variable array(string) aka - //! Country name and as-known-as, if any +  //! @decl string name +  //! @decl array(string) aka +  //! Country name and also-known-as, if any       string name;    array(string) aka=({});    - //! variable int former - //! Flag that is set if this isn't a country anymore - //! (Like USSR.) -  +  //! Flag that is set if this country doesn't exist anymore. +  //! (eg USSR.)    int former=0;    - //! method string continent() - //! Returns the continent for the country. - //! note: +  //! @decl string continent() +  //! Returns the continent of the country. +  //! @note   //! Some countries are geographically in more then   //! one continent; any of the continents might be   //! returned then, but probably the continent in which
358:    }    }    - //! method string cast("string") +  //! @decl string cast("string")    //! It is possible to cast a country to a string,    //! which will be the same as performing - //! <tt>country->name;</tt>. -  +  //! @code{country->name;@}.    string cast(string to)    {    if (to[..5]=="string") return name;
378:      }    - //! module Geography - //! submodule Countries -  - //! constant array(Country) countries - //! All known countries. -  - //! method Country from_domain(string domain) + //! @decl Country from_domain(string domain)   //! Look up a country from a domain name.   //! Returns zero if the domain doesn't map   //! to a country. Note that there are some - //! valid domains that doesn't: - //! <dl compact> - //! <dt>INT <dd>International - //! <dt>MIL <dd>US Military - //! <dt>NET <dd>Network - //! <dt>ORG <dd>Non-Profit Organization - //! <dt>ARPA <dd>Old style Arpanet - //! <dt>NATO <dd>Nato field - //! </dl> + //! valid domains that don't: + //! @dl + //! @item INT + //! International + //! @item MIL + //! US Military + //! @item NET + //! Network + //! @item ORG + //! Non-Profit Organization + //! @item ARPA + //! Old style Arpanet + //! @item NATO + //! Nato field + //! @enddl   //!   //! And that USA has six domains, Great Britain and france two: - //! <dl compact> - //! <dt>COM <dd>US Commercial - //! <dt>EDU <dd>US Educational - //! <dt>MIL <dd>US Military - //! <dt>GOV <dd>US Government - //! <dt>UM <dd>US Minor Outlying Islands - //! <dt>GB <dd>Great Britain (UK) - //! <dt>UK <dd>United Kingdom - //! <dt>FR <dd>France - //! <dt>FX <dd>France, Metropolitan - //! </dl> + //! @dl + //! @item COM + //! US Commercial + //! @item EDU + //! US Educational + //! @item MIL + //! US Military + //! @item GOV + //! US Government + //! @item UM + //! US Minor Outlying Islands + //! @item GB + //! Great Britain (UK) + //! @item UK + //! United Kingdom + //! @item FR + //! France + //! @item FX + //! France, Metropolitan + //! @enddl    -  +    static private mapping _from_domain=0;      Country from_domain(string domain)
432:    return _from_domain[upper_case(domain)];   }    - //! method Country from_domain(string name) + //! @decl Country from_domain(string name)   //! Look up a country from its name or aka.   //! The search is case-insensitive but   //! regards whitespace and interpunctation.
463:    return _from_name[lower_case(name)];   }    - //! method mapping(string:array(Country)) continents() + //! @decl mapping(string:array(Country)) continents()   //! Gives back a mapping from continent name to   //! an array of the countries on that continent.   //!   //! The continents are: - //! <pre> + //! @pre{   //! "Europe"   //! "Africa"   //! "Asia"
476:   //! "South America"   //! "Oceania"   //! "Antarctica" - //! </pre> - //! Note: - //! Some countries are considered on more then one continent. + //! @} + //! @note + //! Some countries are considered to be on more than one continent.      static private mapping _cached_continents;   
508:    return _cached_continents;   }    - //! method mixed `[](string what) - //! method mixed `->(string what) - //! Convenience function for getting a country + //! @decl mixed `[](string what) + //! @decl mixed `->(string what) + //! Convenience functions for getting a country   //! the name-space way; it looks up whatever it   //! is in the name- and domain-space and   //! returns that country if possible:   //! - //! <pre> - //! &gt; Geography.Countries.se; + //! @pre{ + //! > Geography.Countries.se;   //! Result: Country(Sweden) - //! &gt; Geography.Countries.djibouti; + //! > Geography.Countries.djibouti;   //! Result: Country(Djibouti) - //! &gt; Geography.Countries.com; + //! > Geography.Countries.com;   //! Result: Country(United States) - //! &gt; Geography.Countries.wallis_and_futuna_islands->iso2; + //! > Geography.Countries.wallis_and_futuna_islands->iso2;   //! Result: "WF" - //! </pre> + //! @}      Country|function(string:Country)|array(Country)|program    `->(string what)