Skip to content

Commit

Permalink
Improve Domain documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nyamsprod committed Nov 5, 2019
1 parent 9f531fa commit f8f7b68
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/components/2.0/domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ title: The Domain component
The Domain Host
=======

The library provides a `Domain` class to ease domain host creation and manipulation. This object exposes:
The library provides a `Domain` class to ease domain host creation and manipulation.

The class validates domain names according to [RFC952](https://tools.ietf.org/html/rfc952) and [RFC1123](https://tools.ietf.org/html/rfc1123#page-13)

In addition it exposes:

- the [package common API](/components/2.0/api/),
- the [Host common API](/components/2.0/host/),
Expand All @@ -25,6 +29,7 @@ public Domain::__construct($host): void
~~~

<p class="message-notice">submitted string is normalized to be <code>RFC3986</code> compliant.</p>
<p class="message-warning">The <code>$host</code> can not be <code>null</code> or the empty string as they represents an invalid domain name.</p>

## The Domain Host API

Expand Down

0 comments on commit f8f7b68

Please sign in to comment.