Skip to content

Commit

Permalink
Remove inlinke {@link}s
Browse files Browse the repository at this point in the history
phpDocumentor2's support for these is mostly not working and the
directives end up showing.
  • Loading branch information
horgh committed Mar 13, 2019
1 parent e1b7516 commit cd5977d
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 31 deletions.
4 changes: 2 additions & 2 deletions src/Model/City.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* Represented country data for the requested IP address. The represented
* country is used for things like military bases. It is only present when
* the represented country differs from the country.
* @property-read array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
* @property-read array $subdivisions An array \GeoIp2\Record\Subdivision
* objects representing the country subdivisions for the requested IP
* address. The number and type of subdivisions varies by country, but a
* subdivision is typically a state, province, county, etc. Subdivisions
Expand All @@ -40,7 +40,7 @@
* @property-read \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
* representing the most specific subdivision returned. If the response
* did not contain any subdivisions, this method returns an empty
* {@link \GeoIp2\Record\Subdivision} object.
* \GeoIp2\Record\Subdivision object.
* @property-read \GeoIp2\Record\Traits $traits Data for the traits of the
* requested IP address.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Model/Enterprise.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* Represented country data for the requested IP address. The represented
* country is used for things like military bases. It is only present when
* the represented country differs from the country.
* @property-read array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
* @property-read array $subdivisions An array of \GeoIp2\Record\Subdivision
* objects representing the country subdivisions for the requested IP
* address. The number and type of subdivisions varies by country, but a
* subdivision is typically a state, province, county, etc. Subdivisions
Expand All @@ -38,7 +38,7 @@
* @property-read \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
* representing the most specific subdivision returned. If the response
* did not contain any subdivisions, this method returns an empty
* {@link \GeoIp2\Record\Subdivision} object.
* \GeoIp2\Record\Subdivision object.
* @property-read \GeoIp2\Record\Traits $traits Data for the traits of the
* requested IP address.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Model/Insights.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* Represented country data for the requested IP address. The represented
* country is used for things like military bases. It is only present when
* the represented country differs from the country.
* @property-read array $subdivisions An array of {@link \GeoIp2\Record\Subdivision}
* @property-read array $subdivisions An array of \GeoIp2\Record\Subdivision
* objects representing the country subdivisions for the requested IP
* address. The number and type of subdivisions varies by country, but a
* subdivision is typically a state, province, county, etc. Subdivisions
Expand All @@ -38,7 +38,7 @@
* @property-read \GeoIp2\Record\Subdivision $mostSpecificSubdivision An object
* representing the most specific subdivision returned. If the response
* did not contain any subdivisions, this method returns an empty
* {@link \GeoIp2\Record\Subdivision} object.
* \GeoIp2\Record\Subdivision object.
* @property-read \GeoIp2\Record\Traits $traits Data for the traits of the
* requested IP address.
*/
Expand Down
7 changes: 3 additions & 4 deletions src/Record/Country.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@
* @property-read bool $isInEuropeanUnion This is true if the country is a
* member state of the European Union. This attribute is returned by all
* location services and databases.
* @property-read string|null $isoCode The
* {@link * https://en.wikipedia.org/wiki/ISO_3166-1 two-character ISO 3166-1 alpha
* code} for the country. This attribute is returned by all location services
* and databases.
* @property-read string|null $isoCode The two-character ISO 3166-1 alpha code
* for the country. See https://en.wikipedia.org/wiki/ISO_3166-1. This
* attribute is returned by all location services and databases.
* @property-read string|null $name The name of the country based on the locales
* list passed to the constructor. This attribute is returned by all location
* services and databases.
Expand Down
8 changes: 4 additions & 4 deletions src/Record/Location.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@
* from the Insights service.
* @property-read int|null $metroCode The metro code of the location if the location
* is in the US. MaxMind returns the same metro codes as the
* {@link * https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions
* Google AdWords API}.
* Google AdWords API. See
* https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions.
* @property-read string|null $timeZone The time zone associated with location, as
* specified by the {@link https://www.iana.org/time-zones IANA Time Zone
* Database}, e.g., "America/New_York".
* specified by the IANA Time Zone Database, e.g., "America/New_York". See
* https://www.iana.org/time-zones.
*/
class Location extends AbstractRecord
{
Expand Down
4 changes: 2 additions & 2 deletions src/Record/RepresentedCountry.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
* @property-read bool $isInEuropeanUnion This is true if the country is a
* member state of the European Union. This attribute is returned by all
* location services and databases.
* @property-read string|null $isoCode The {@link https://en.wikipedia.org/wiki/ISO_3166-1
* two-character ISO 3166-1 alpha code} for the country.
* @property-read string|null $isoCode The two-character ISO 3166-1 alpha code
* for the country. See https://en.wikipedia.org/wiki/ISO_3166-1.
* @property-read string|null $name The name of the country based on the locales list
* passed to the constructor.
* @property-read array|null $names An array map where the keys are locale codes and
Expand Down
6 changes: 3 additions & 3 deletions src/Record/Subdivision.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
* This attribute is returned by all location databases and services besides
* Country.
* @property-read string|null $isoCode This is a string up to three characters long
* contain the subdivision portion of the
* {@link * https://en.wikipedia.org/wiki/ISO_3166-2 ISO 3166-2 code}. This attribute
* is returned by all location databases and services except Country.
* contain the subdivision portion of the ISO 3166-2 code. See
* https://en.wikipedia.org/wiki/ISO_3166-2. This attribute is returned by all
* location databases and services except Country.
* @property-read string|null $name The name of the subdivision based on the
* locales list passed to the constructor. This attribute is returned by all
* location databases and services besides Country.
Expand Down
24 changes: 12 additions & 12 deletions src/Record/Traits.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@
*
* This record is returned by all location services and databases.
*
* @property-read int|null $autonomousSystemNumber The
* {@link * https://en.wikipedia.org/wiki/Autonomous_system_(Internet) autonomous
* system number} associated with the IP address. This attribute is only
* available from the City and Insights web service and the GeoIP2
* @property-read int|null $autonomousSystemNumber The autonomous system number
* associated with the IP address. See
* https://en.wikipedia.org/wiki/Autonomous_system_(Internet%29. This attribute
* is only available from the City and Insights web service and the GeoIP2
* Enterprise database.
* @property-read string|null $autonomousSystemOrganization The organization
* associated with the registered {@link * https://en.wikipedia.org/wiki/Autonomous_system_(Internet) autonomous
* system number} for the IP address. This attribute is only available from
* the City and Insights web service and the GeoIP2 Enterprise
* database.
* associated with the registered autonomous system number for the IP address.
* See https://en.wikipedia.org/wiki/Autonomous_system_(Internet%29. This
* attribute is only available from the City and Insights web service and the
* GeoIP2 Enterprise database.
* @property-read string|null $connectionType The connection type may take the
* following values: "Dialup", "Cable/DSL", "Corporate", "Cellular".
* Additional values may be added in the future. This attribute is only
Expand All @@ -35,10 +35,10 @@
* @property-read bool $isAnonymous This is true if the IP address belongs to
* any sort of anonymous network. This property is only available from GeoIP2
* Precision Insights.
* @property-read bool $isAnonymousProxy *Deprecated.* Please see our
* {@link * https://www.maxmind.com/en/geoip2-anonymous-ip-database GeoIP2
* Anonymous IP database} to determine whether the IP address is used by an
* anonymizing service.
* @property-read bool $isAnonymousProxy *Deprecated.* Please see our GeoIP2
* Anonymous IP database
* (https://www.maxmind.com/en/geoip2-anonymous-ip-database) to determine
* whether the IP address is used by an anonymizing service.
* @property-read bool $isAnonymousVpn This is true if the IP address is
* registered to an anonymous VPN provider. If a VPN provider does not register
* subnets under names associated with them, we will likely only flag their IP
Expand Down

0 comments on commit cd5977d

Please sign in to comment.