← Back to branch summary

~abreu-alexandre/ubuntu-html5-theme/add-button-class-ubuntu

« back to all changes in this revision

Viewing changes to 0.1/ambiance/js/yuidoc-theme/partials/events.handlebars

  • Committer: Tarmac
  • Author(s): Kyle Nitzsche
  • Date: 2013-11-01 20:38:57 UTC
  • mfrom: (90.1.4 trunk)
  • Revision ID: tarmac-20131101203857-o50mfgnebkogb950
This MR does three main things:
1) Implements yuidoc comments in all js files to support API doc generation, and provides yuidoc assets (theme dir and json file) needed to build the API docs. Bug LP: #1241029
3) Provides JS classes for shape and page with corresponding UbuntuUI prototype constructor functions. Bug LP: #1243248
4) Adds a getEl(UbuntuUIObject) to return the element for any Ubuntu class. Also LP: #1243248.

Approved by PS Jenkins bot, David Barth.

Show diffs side-by-side

added added

removed removed

Lines of Context:
0.1/ambiance/js/yuidoc-theme/partials/events.handlebars
 
1
<a name="events_{{name}}"></a>
 
2
<div class="events item">
 
3
    `{{name}}` {{#if type}}<strong>&lt;{{#crossLink type}}{{/crossLink}}&gt;</strong>{{/if}}
 
4
    {{#if extended_from}}<em>`/* Extended from {{extended_from}} */</em>`{{/if}}
 
5
    {{#if overwritten_from}}<em>`/* Overwritten from {{name}} */`</em>{{/if}}
 
6
    <br>
 
7
    <span class="foundat"><a href="../{{foundAt}}">`{{file}}:{{line}}`</a></span>
 
8
    {{{eventDescription}}}
 
9
    {{#if params}}
 
10
    <strong>Extra event object properties:</strong>
 
11
    <ul>
 
12
    {{#params}}
 
13
        <li>
 
14
        {{#if optional}}
 
15
            `[{{name}}{{#if optdefault}}={{optdefault}}{{/if}}]` <strong>&lt;{{#crossLink type}}{{/crossLink}}&gt;</strong>
 
16
        {{else}}
 
17
            `{{name}}` <strong>&lt;{{#crossLink type}}{{/crossLink}}&gt;</strong>
 
18
        {{/if}}
 
19
        {{#if multiple}}
 
20
            <abbr title="Denotes that this argument can contain (n) number">(*..n)</abbr>
 
21
        {{/if}}
 
22
        {{{description}}}
 
23
            {{#if props}}
 
24
            <ul>
 
25
            {{#props}}
 
26
                <li>`{{name}}` <strong>&lt;{{#crossLink type}}{{/crossLink}}&gt;</strong> {{{description}}}
 
27
            {{/props}}
 
28
            </ul>
 
29
            {{/if}}
 
30
        </li>
 
31
    {{/params}}
 
32
    </ul>
 
33
    {{/if}}
 
34
</div>
 
35