diff --git a/docs/syntax/index.mustache b/docs/syntax/index.mustache index 679ba9a7..22ae0fe0 100644 --- a/docs/syntax/index.mustache +++ b/docs/syntax/index.mustache @@ -134,6 +134,33 @@ function IO (config) {

+ + `element` + +``` +/** + * This is the foo element description... + * + * @element x-foo + */ +``` + + +

Indicates that the block describes a Custom Element. + The `@attribute` tag works as a attribute of the element + when you specify a `@element` tag. You can also specify the + `@parents`, `@contents`, + and `@interface` tag for the element.

+ +

+ See also: + `@attribute`, + `@parents`, + `@contents`, + `@interface`. +

+ + `method` @@ -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.

+

If you specify a `@element` tag, the `@attribute` tag works as + a attribute of the element.

+

- See also: + See also: `@element`, `@property`, `@default`, `@class`, @@ -1112,6 +1142,75 @@ render: function () {

+ + `parents` + +``` +/** + * @element x-foo + * @parents + */ +``` + + +

It's a secondary tag for the `@element` tag. + Indicates that the parent element of the element you specified.

+ +

+ See also: + `@element`, + `@attribute`, + `@contents`, + `@interface`. +

+ + + + `contents` + +``` +/** + * @element x-foo + * @contents + */ +``` + + +

It's a secondary tag for the `@element` tag. + Indicates that the element contains in the element you specified.

+ +

+ See also: + `@element`, + `@attribute`, + `@parents`, + `@interface`. +

+ + + + `interface` + +``` +/** + * @element x-foo + * @interface XFooElement + */ +``` + + +

It's a secondary tag for the `@element` tag. + Indicates that the interface for the element you specified.

+ +

+ See also: + `@element`, + `@attribute`, + `@parents`, + `@contents`. +

+ +

A * indicates that you can supply multiple tags of that type in the same block.