Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs on supporting Custom Elements #1

Merged
merged 1 commit into from
Aug 10, 2015
Merged

Update docs on supporting Custom Elements #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 100 additions & 1 deletion docs/syntax/index.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,33 @@ function IO (config) {
</p>
</td>
</tr>
<tr id="element">
<td>`element`</td>
<td>
```
/**
* This is the foo element description...
*
* @element x-foo
*/
```
</td>
<td>
<p>Indicates that the block describes a Custom Element.
The <a href="#attribute">`@attribute`</a> tag works as a attribute of the element
when you specify a `@element` tag. You can also specify the
<a href="#parents">`@parents`</a>, <a href="#contents">`@contents`</a>,
and <a href="#interface">`@interface`</a> tag for the element.</p>

<p>
See also:
<a href="#attribute">`@attribute`</a>,
<a href="#parents">`@parents`</a>,
<a href="#contents">`@contents`</a>,
<a href="#interface">`@interface`</a>.
</p>
</td>
</tr>
<tr id="method">
<td>`method`</td>
<td>
Expand Down Expand Up @@ -267,8 +294,11 @@ ATTRS[RENDERED] = {
YUI will automatically generate documentation for the attribute's change events throughout the source tree,
with no extra YUIDoc comments needed from you.</p>

<p>If you specify a <a href="#element">`@element`</a> tag, the `@attribute` tag works as
a attribute of the element.</p>

<p>
See also:
See also: <a href="#element">`@element`</a>,
<a href="#property">`@property`</a>,
<a href="#default">`@default`</a>,
<a href="#class">`@class`</a>,
Expand Down Expand Up @@ -1112,6 +1142,75 @@ render: function () {
</p>
</td>
</tr>
<tr id="parents">
<td>`parents`</td>
<td>
```
/**
* @element x-foo
* @parents <body>
*/
```
</td>
<td>
<p>It's a secondary tag for the <a href="#element">`@element`</a> tag.
Indicates that the parent element of the element you specified.</p>

<p>
See also:
<a href="#element">`@element`</a>,
<a href="#attribute">`@attribute`</a>,
<a href="#contents">`@contents`</a>,
<a href="#interface">`@interface`</a>.
</p>
</td>
</tr>
<tr id="contents">
<td>`contents`</td>
<td>
```
/**
* @element x-foo
* @contents <x-bar>
*/
```
</td>
<td>
<p>It's a secondary tag for the <a href="#element">`@element`</a> tag.
Indicates that the element contains in the element you specified.</p>

<p>
See also:
<a href="#element">`@element`</a>,
<a href="#attribute">`@attribute`</a>,
<a href="#parents">`@parents`</a>,
<a href="#interface">`@interface`</a>.
</p>
</td>
</tr>
<tr id="interface">
<td>`interface`</td>
<td>
```
/**
* @element x-foo
* @interface XFooElement
*/
```
</td>
<td>
<p>It's a secondary tag for the <a href="#element">`@element`</a> tag.
Indicates that the interface for the element you specified.</p>

<p>
See also:
<a href="#element">`@element`</a>,
<a href="#attribute">`@attribute`</a>,
<a href="#parents">`@parents`</a>,
<a href="#contents">`@contents`</a>.
</p>
</td>
</tr>
</table>

<p>A <strong>*</strong> indicates that you can supply multiple tags of that type in the same block.</p>
Expand Down