aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>2014-10-31 17:35:08 -0200
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>2014-10-31 17:35:08 -0200
commit2e6c685556e589d842bc059b1b1fefb8bc6df865 (patch)
treedf1dcc74b5263cf3638d0844203de4be814e5cef
parent22c4ea6ab7fdbc23e68dbfbe5056f90171e9a019 (diff)
Doxygen: Document libdvbv5 countries.h
Add Doxygen documentation for the enum and functions declared at countries.h and make Doxygen read it. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
-rw-r--r--doxygen_libdvbv5.cfg1
-rw-r--r--lib/include/libdvbv5/countries.h577
2 files changed, 571 insertions, 7 deletions
diff --git a/doxygen_libdvbv5.cfg b/doxygen_libdvbv5.cfg
index 21c36269..f9deabbc 100644
--- a/doxygen_libdvbv5.cfg
+++ b/doxygen_libdvbv5.cfg
@@ -764,6 +764,7 @@ INPUT = $(SRCDIR)/doc/libdvbv5-index.doc \
$(SRCDIR)/lib/include/libdvbv5/sdt.h \
$(SRCDIR)/lib/include/libdvbv5/vct.h \
$(SRCDIR)/lib/include/libdvbv5/crc32.h \
+ $(SRCDIR)/lib/include/libdvbv5/countries.h \
$(SRCDIR)/lib/include/libdvbv5/mpeg_es.h \
$(SRCDIR)/lib/include/libdvbv5/mpeg_pes.h \
$(SRCDIR)/lib/include/libdvbv5/mpeg_ts.h \
diff --git a/lib/include/libdvbv5/countries.h b/lib/include/libdvbv5/countries.h
index 07667175..9bb8b055 100644
--- a/lib/include/libdvbv5/countries.h
+++ b/lib/include/libdvbv5/countries.h
@@ -36,7 +36,512 @@
extern "C" {
#endif
-/* ISO-3166-1 alpha-2 country code */
+/**
+ * @enum dvb_country_t
+ * @brief ISO-3166-1 alpha-2 country code
+ * @ingroup ancillary
+ *
+ * @var COUNTRY_UNKNOWN
+ * @brief (Unknown Country)
+ * @var AD
+ * @brief Andorra
+ * @var AE
+ * @brief United Arab Emirates
+ * @var AF
+ * @brief Afghanistan
+ * @var AG
+ * @brief Antigua and Barbuda
+ * @var AI
+ * @brief Anguilla
+ * @var AL
+ * @brief Albania
+ * @var AM
+ * @brief Armenia
+ * @var AO
+ * @brief Angola
+ * @var AQ
+ * @brief Antarctica
+ * @var AR
+ * @brief Argentina
+ * @var AS
+ * @brief American Samoa
+ * @var AT
+ * @brief Austria
+ * @var AU
+ * @brief Australia
+ * @var AW
+ * @brief Aruba
+ * @var AX
+ * @brief Aland Islands
+ * @var AZ
+ * @brief Azerbaijan
+ * @var BA
+ * @brief Bosnia and Herzegovina
+ * @var BB
+ * @brief Barbados
+ * @var BD
+ * @brief Bangladesh
+ * @var BE
+ * @brief Belgium
+ * @var BF
+ * @brief Burkina Faso
+ * @var BG
+ * @brief Bulgaria
+ * @var BH
+ * @brief Bahrain
+ * @var BI
+ * @brief Burundi
+ * @var BJ
+ * @brief Benin
+ * @var BL
+ * @brief Saint Barthelemy
+ * @var BM
+ * @brief Bermuda
+ * @var BN
+ * @brief Brunei Darussalam
+ * @var BO
+ * @brief Plurinational State of Bolivia
+ * @var BQ
+ * @brief Bonaire, Saint Eustatius and Saba
+ * @var BR
+ * @brief Brazil
+ * @var BS
+ * @brief Bahamas
+ * @var BT
+ * @brief Bhutan
+ * @var BV
+ * @brief Bouvet Island
+ * @var BW
+ * @brief Botswana
+ * @var BY
+ * @brief Belarus
+ * @var BZ
+ * @brief Belize
+ * @var CA
+ * @brief Canada
+ * @var CC
+ * @brief Cocos (Keeling) Islands
+ * @var CD
+ * @brief The Democratic Republic of the Congo
+ * @var CF
+ * @brief Central African Republic
+ * @var CG
+ * @brief Congo
+ * @var CH
+ * @brief Switzerland
+ * @var CI
+ * @brief Cote d'Ivoire
+ * @var CK
+ * @brief Cook Islands
+ * @var CL
+ * @brief Chile
+ * @var CM
+ * @brief Cameroon
+ * @var CN
+ * @brief China
+ * @var CO
+ * @brief Colombia
+ * @var CR
+ * @brief Costa Rica
+ * @var CU
+ * @brief Cuba
+ * @var CV
+ * @brief Cape Verde
+ * @var CW
+ * @brief Curacao
+ * @var CX
+ * @brief Christmas Island
+ * @var CY
+ * @brief Cyprus
+ * @var CZ
+ * @brief Czech Republic
+ * @var DE
+ * @brief Germany
+ * @var DJ
+ * @brief Djibouti
+ * @var DK
+ * @brief Denmark
+ * @var DM
+ * @brief Dominica
+ * @var DO
+ * @brief Dominican Republic
+ * @var DZ
+ * @brief Algeria
+ * @var EC
+ * @brief Ecuador
+ * @var EE
+ * @brief Estonia
+ * @var EG
+ * @brief Egypt
+ * @var EH
+ * @brief Western Sahara
+ * @var ER
+ * @brief Eritrea
+ * @var ES
+ * @brief Spain
+ * @var ET
+ * @brief Ethiopia
+ * @var FI
+ * @brief Finland
+ * @var FJ
+ * @brief Fiji
+ * @var FK
+ * @brief Falkland Islands (Malvinas)
+ * @var FM
+ * @brief Federated States of Micronesia
+ * @var FO
+ * @brief Faroe Islands
+ * @var FR
+ * @brief France
+ * @var GA
+ * @brief Gabon
+ * @var GB
+ * @brief United Kingdom
+ * @var GD
+ * @brief Grenada
+ * @var GE
+ * @brief Georgia
+ * @var GF
+ * @brief French Guiana
+ * @var GG
+ * @brief Guernsey
+ * @var GH
+ * @brief Ghana
+ * @var GI
+ * @brief Gibraltar
+ * @var GL
+ * @brief Greenland
+ * @var GM
+ * @brief Gambia
+ * @var GN
+ * @brief Guinea
+ * @var GP
+ * @brief Guadeloupe
+ * @var GQ
+ * @brief Equatorial Guinea
+ * @var GR
+ * @brief Greece
+ * @var GS
+ * @brief South Georgia and the South Sandwich Islands
+ * @var GT
+ * @brief Guatemala
+ * @var GU
+ * @brief Guam
+ * @var GW
+ * @brief Guinea-Bissau
+ * @var GY
+ * @brief Guyana
+ * @var HK
+ * @brief Hong Kong
+ * @var HM
+ * @brief Heard Island and McDonald Islands
+ * @var HN
+ * @brief Honduras
+ * @var HR
+ * @brief Croatia
+ * @var HT
+ * @brief Haiti
+ * @var HU
+ * @brief Hungary
+ * @var ID
+ * @brief Indonesia
+ * @var IE
+ * @brief Ireland
+ * @var IL
+ * @brief Israel
+ * @var IM
+ * @brief Isle of Man
+ * @var IN
+ * @brief India
+ * @var IO
+ * @brief British Indian Ocean Territory
+ * @var IQ
+ * @brief Iraq
+ * @var IR
+ * @brief Islamic Republic of Iran
+ * @var IS
+ * @brief Iceland
+ * @var IT
+ * @brief Italy
+ * @var JE
+ * @brief Jersey
+ * @var JM
+ * @brief Jamaica
+ * @var JO
+ * @brief Jordan
+ * @var JP
+ * @brief Japan
+ * @var KE
+ * @brief Kenya
+ * @var KG
+ * @brief Kyrgyzstan
+ * @var KH
+ * @brief Cambodia
+ * @var KI
+ * @brief Kiribati
+ * @var KM
+ * @brief Comoros
+ * @var KN
+ * @brief Saint Kitts and Nevis
+ * @var KP
+ * @brief Democratic People's Republic of Korea
+ * @var KR
+ * @brief Republic of Korea
+ * @var KW
+ * @brief Kuwait
+ * @var KY
+ * @brief Cayman Islands
+ * @var KZ
+ * @brief Kazakhstan
+ * @var LA
+ * @brief Lao People's Democratic Republic
+ * @var LB
+ * @brief Lebanon
+ * @var LC
+ * @brief Saint Lucia
+ * @var LI
+ * @brief Liechtenstein
+ * @var LK
+ * @brief Sri Lanka
+ * @var LR
+ * @brief Liberia
+ * @var LS
+ * @brief Lesotho
+ * @var LT
+ * @brief Lithuania
+ * @var LU
+ * @brief Luxembourg
+ * @var LV
+ * @brief Latvia
+ * @var LY
+ * @brief Libyan Arab Jamahiriya
+ * @var MA
+ * @brief Morocco
+ * @var MC
+ * @brief Monaco
+ * @var MD
+ * @brief Republic of Moldova
+ * @var ME
+ * @brief Montenegro
+ * @var MF
+ * @brief Saint Martin (French part)
+ * @var MG
+ * @brief Madagascar
+ * @var MH
+ * @brief Marshall Islands
+ * @var MK
+ * @brief The Former Yugoslav Republic of Macedonia
+ * @var ML
+ * @brief Mali
+ * @var MM
+ * @brief Myanmar
+ * @var MN
+ * @brief Mongolia
+ * @var MO
+ * @brief Macao
+ * @var MP
+ * @brief Northern Mariana Islands
+ * @var MQ
+ * @brief Martinique
+ * @var MR
+ * @brief Mauritania
+ * @var MS
+ * @brief Montserrat
+ * @var MT
+ * @brief Malta
+ * @var MU
+ * @brief Mauritius
+ * @var MV
+ * @brief Maldives
+ * @var MW
+ * @brief Malawi
+ * @var MX
+ * @brief Mexico
+ * @var MY
+ * @brief Malaysia
+ * @var MZ
+ * @brief Mozambique
+ * @var NA
+ * @brief Namibia
+ * @var NC
+ * @brief New Caledonia
+ * @var NE
+ * @brief Niger
+ * @var NF
+ * @brief Norfolk Island
+ * @var NG
+ * @brief Nigeria
+ * @var NI
+ * @brief Nicaragua
+ * @var NL
+ * @brief Netherlands
+ * @var NO
+ * @brief Norway
+ * @var NP
+ * @brief Nepal
+ * @var NR
+ * @brief Nauru
+ * @var NU
+ * @brief Niue
+ * @var NZ
+ * @brief New Zealand
+ * @var OM
+ * @brief Oman
+ * @var PA
+ * @brief Panama
+ * @var PE
+ * @brief Peru
+ * @var PF
+ * @brief French Polynesia
+ * @var PG
+ * @brief Papua New Guinea
+ * @var PH
+ * @brief Philippines
+ * @var PK
+ * @brief Pakistan
+ * @var PL
+ * @brief Poland
+ * @var PM
+ * @brief Saint Pierre and Miquelon
+ * @var PN
+ * @brief Pitcairn
+ * @var PR
+ * @brief Puerto Rico
+ * @var PS
+ * @brief Occupied Palestinian Territory
+ * @var PT
+ * @brief Portugal
+ * @var PW
+ * @brief Palau
+ * @var PY
+ * @brief Paraguay
+ * @var QA
+ * @brief Qatar
+ * @var RE
+ * @brief Reunion
+ * @var RO
+ * @brief Romania
+ * @var RS
+ * @brief Serbia
+ * @var RU
+ * @brief Russian Federation
+ * @var RW
+ * @brief Rwanda
+ * @var SA
+ * @brief Saudi Arabia
+ * @var SB
+ * @brief Solomon Islands
+ * @var SC
+ * @brief Seychelles
+ * @var SD
+ * @brief Sudan
+ * @var SE
+ * @brief Sweden
+ * @var SG
+ * @brief Singapore
+ * @var SH
+ * @brief Saint Helena, Ascension and Tristan da Cunha
+ * @var SI
+ * @brief Slovenia
+ * @var SJ
+ * @brief Svalbard and Jan Mayen
+ * @var SK
+ * @brief Slovakia
+ * @var SL
+ * @brief Sierra Leone
+ * @var SM
+ * @brief San Marino
+ * @var SN
+ * @brief Senegal
+ * @var SO
+ * @brief Somalia
+ * @var SR
+ * @brief Suriname
+ * @var SS
+ * @brief South Sudan
+ * @var ST
+ * @brief Sao Tome and Principe
+ * @var SV
+ * @brief El Salvador
+ * @var SX
+ * @brief Sint Maarten (Dutch part)
+ * @var SY
+ * @brief Syrian Arab Republic
+ * @var SZ
+ * @brief Swaziland
+ * @var TC
+ * @brief Turks and Caicos Islands
+ * @var TD
+ * @brief Chad
+ * @var TF
+ * @brief French Southern Territories
+ * @var TG
+ * @brief Togo
+ * @var TH
+ * @brief Thailand
+ * @var TJ
+ * @brief Tajikistan
+ * @var TK
+ * @brief Tokelau
+ * @var TL
+ * @brief Timor-Leste
+ * @var TM
+ * @brief Turkmenistan
+ * @var TN
+ * @brief Tunisia
+ * @var TO
+ * @brief Tonga
+ * @var TR
+ * @brief Turkey
+ * @var TT
+ * @brief Trinidad and Tobago
+ * @var TV
+ * @brief Tuvalu
+ * @var TW
+ * @brief Taiwan, Province of China
+ * @var TZ
+ * @brief United Republic of Tanzania
+ * @var UA
+ * @brief Ukraine
+ * @var UG
+ * @brief Uganda
+ * @var UM
+ * @brief United States Minor Outlying Islands
+ * @var US
+ * @brief United States
+ * @var UY
+ * @brief Uruguay
+ * @var UZ
+ * @brief Uzbekistan
+ * @var VA
+ * @brief Holy See (Vatican City State)
+ * @var VC
+ * @brief Saint Vincent and The Grenadines
+ * @var VE
+ * @brief Bolivarian Republic of Venezuela
+ * @var VG
+ * @brief British Virgin Islands
+ * @var VI
+ * @brief U.S. Virgin Islands
+ * @var VN
+ * @brief Viet Nam
+ * @var VU
+ * @brief Vanuatu
+ * @var WF
+ * @brief Wallis and Futuna
+ * @var WS
+ * @brief Samoa
+ * @var YE
+ * @brief Yemen
+ * @var YT
+ * @brief Mayotte
+ * @var ZA
+ * @brief South Africa
+ * @var ZM
+ * @brief Zambia
+ * @var ZW
+ * @brief Zimbabwe
+ */
enum dvb_country_t {
COUNTRY_UNKNOWN,
@@ -291,14 +796,72 @@ enum dvb_country_t {
ZW,
};
-extern enum dvb_country_t dvb_country_a2_to_id (const char * name);
-extern enum dvb_country_t dvb_country_a3_to_id (const char * name);
+/**
+ * @brief Converts an Unix-like 2-letter Country code into enum dvb_country_t
+ * @ingroup ancillary
+ *
+ * @param name two-letter Country code.
+ *
+ * @return It returns the corresponding enum dvb_country_t ID. If not found,
+ * returns COUNTRY_UNKNOWN.
+ */
+enum dvb_country_t dvb_country_a2_to_id(const char *name);
+
+/**
+ * @brief Converts a 3-letter Country code as used by MPEG-TS tables into
+ * enum dvb_country_t
+ * @ingroup ancillary
+ *
+ * @param name three-letter Country code.
+ *
+ * @return It returns the corresponding enum dvb_country_t ID. If not found,
+ * returns COUNTRY_UNKNOWN.
+ */
+enum dvb_country_t dvb_country_a3_to_id(const char *name);
+
+/**
+ * @brief Converts an enum dvb_country_t into Unix-like 2-letter Country code
+ * @ingroup ancillary
+ *
+ * @param id enum dvb_country_t ID.
+ *
+ * @return It returns the 2-letter country code string that corresponts to the
+ * Country. If not found, returns NULL.
+ */
+const char *dvb_country_to_2letters(int id);
+
+/**
+ * @brief Converts an enum dvb_country_t into a 3-letter Country code
+ * as used by MPEG-TS tables
+ * @ingroup ancillary
+ *
+ * @param id enum dvb_country_t ID.
+ *
+ * @return It returns the 3-letter country code string that corresponts to the
+ * Country. If not found, returns NULL.
+ */
+const char *dvb_country_to_3letters(int id);
-extern const char *dvb_country_to_2letters(int id);
-extern const char *dvb_country_to_3letters(int id);
-extern const char *dvb_country_to_name(int id);
+/**
+ * @brief Converts an enum dvb_country_t into a Country name
+ * as used by MPEG-TS tables
+ * @ingroup ancillary
+ *
+ * @param id enum dvb_country_t ID.
+ *
+ * @return It returns a string with the Country name that corresponts to the
+ * country. If not found, returns NULL.
+ */
+const char *dvb_country_to_name(int id);
-extern enum dvb_country_t dvb_guess_user_country(void);
+/**
+ * @brief Guess the country code from the Unix environment variables
+ * @ingroup ancillary
+ *
+ * @return It returns the corresponding enum dvb_country_t ID. If not found,
+ * returns COUNTRY_UNKNOWN.
+ */
+enum dvb_country_t dvb_guess_user_country(void);
#ifdef __cplusplus
}

Privacy Policy