Added basic docs for the API

This commit is contained in:
Gregory Oschwald
2013-05-10 10:47:11 -07:00
parent 8922b3a164
commit 694195fedf
19 changed files with 509 additions and 14 deletions
+25
View File
@@ -2,8 +2,33 @@
namespace GeoIP2\Record;
/**
* Contains data for the country record associated with an IP address
*
* This record is returned by all the end points.
*
* @property int $confidence A value from 0-100 indicating MaxMind's
* confidence that the country is correct. This attribute is only available
* from the Omni end point.
*
* @property int $geonameId The GeoName ID for the country. This attribute is
* returned by all end points.
*
* @property string $isoCode The {@link http://en.wikipedia.org/wiki/ISO_3166-1
* two-character ISO 3166-1 alpha code} for the country. This attribute is
* returned by all end points.
*
* @property string $name The name of the country based on the languages list
* passed to the constructor. This attribute is returned by all end points.
*
* @property array $names An array map where the keys are language codes and
* the values are names. This attribute is returned by all end points.
*/
class Country extends AbstractPlaceRecord
{
/**
* @ignore
*/
protected $validAttributes = array(
'confidence',
'geonameId',