Skip to content

Commit 1cd6851

Browse files
committed
chore: update doc
1 parent ab40b07 commit 1cd6851

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

website/docs/component-event.md

+12
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ The following sections explain the properties of the domain object:
3737
- [Touched at](#touched-at)
3838
- [Summary](#summary)
3939
- [Description](#description)
40+
- [HTML Description](#html-description)
4041
- [Occurrence](#occurrence)
4142
- [Location](#location)
4243
- [Organizer](#organizer)
@@ -113,6 +114,17 @@ $event = new Event();
113114
$event->setDescription('Lorem Ipsum Dolor...');
114115
```
115116

117+
### HTML Description
118+
119+
In addition to the description, it is possible to add an alternative HTML description for clients that support it (ie. Outlook).
120+
121+
```php
122+
use Eluceo\iCal\Domain\Entity\Event;
123+
124+
$event = new Event();
125+
$event->setHtmlDescription('<p>Lorem Ipsum Dolor...</p>');
126+
```
127+
116128
### URL
117129

118130
The URL can be used to link to an arbitrary resource.

0 commit comments

Comments
 (0)