Changeset 4907


Ignore:
Timestamp:
01/08/10 16:46:53 (6 years ago)
Author:
fredck
Message:

Enhancements to the documentation templates for events.

Location:
CKEditor/trunk
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • CKEditor/trunk/_dev/docs_build/template/class.tmpl

    r4906 r4907  
    598598                                <for each="member" in="ownEvents">
    599599                                        <a name="event:{+Link.symbolNameToLinkName(member)+}"> </a>
    600                                         <div class="fixedFont">{!
     600                                        <div class="fixedFont" style="float:left">{!
    601601                                                if (member.isPrivate) output += "&lt;private&gt; ";
    602602                                                if (member.isInner) output += "&lt;inner&gt; ";
     
    605605                                       
    606606                                        <if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
    607                                         <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+}
    608                                        
    609                                         </div>
     607                                        <if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if>
     608                                        <b>{+member.name+}</b> : &lt;object&gt;.{+new Link().toSymbol('CKEDITOR.event#on').withText('on')+}( '{+member.name+}', function( e ){ ... } )
     609                                       
     610                                        </div>
     611                                        <div style="float:right">
     612                                                <span class="heading">Since:</span>
     613                                                        <if test="member.since">
     614                                                                {+ member.since +}
     615                                                        <else />
     616                                                                3.0
     617                                                        </if>
     618                                        </div>
     619                                        <div style="clear:both"></div>
    610620                                        <div class="description">
    611621                                                {+resolveLinks(member.desc)+}
     
    619629                                        <if test="member.example.length">
    620630                                        <for each="example" in="member.example">
    621                                         <pre class="code">{+example+}</pre>
     631                                                <if test="example.desc">
     632                                                        <pre class="code">{+example+}</pre>
     633                                                </if>
    622634                                        </for>
    623                                         </if>
    624                                        
    625                                                 <if test="member.params.length">
     635                                        <else />
     636                                                <pre class="code"><span style="color:red">NO EXAMPLE AVAILABLE</span></pre>
     637                                        </if>
     638                                       
    626639                                                        <dl class="detailList">
    627640                                                        <dt class="heading">Parameters:</dt>
     641                                                                <dt>
     642                                                                        <span class="light fixedFont">{{+new Link().toSymbol('CKEDITOR.eventInfo')+}}</span> <b>e</b>
     643                                                                </dt>
     644                                                                <dd>The standard event object passed to event listeners.</dd>
     645
    628646                                                        <for each="item" in="member.params">
    629647                                                                <dt>
    630                                                                         {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
     648                                                                        {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>e.{+item.name+}</b>
    631649                                                                        <if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
    632650                                                                </dt>
     
    634652                                                        </for>
    635653                                                        </dl>
    636                                                 </if>
     654
    637655                                                <if test="member.deprecated">
    638656                                                        <dl class="detailList">
     
    641659                                                                {+ resolveLinks(member.deprecated) +}
    642660                                                        </dt>
    643                                                         </dl>
    644                                                 </if>
    645                                                 <if test="member.since">
    646                                                         <dl class="detailList">
    647                                                         <dt class="heading">Since:</dt>
    648                                                                 <dd>{+ member.since +}</dd>
    649                                                         </dl>
    650661                                                        </dl>
    651662                                                </if>
  • CKEditor/trunk/_source/core/_bootstrap.js

    r4905 r4907  
    8282 * @name CKEDITOR#loaded
    8383 * @event
    84  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    8584 */
  • CKEditor/trunk/_source/core/ckeditor.js

    r4905 r4907  
    101101 * @name CKEDITOR#currentInstance
    102102 * @event
    103  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    104103 */
  • CKEditor/trunk/_source/core/editor.js

    r4906 r4907  
    699699 * @name CKEDITOR#instanceCreated
    700700 * @event
    701  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    702  * @param {CKEDITOR.editor} e.editor The editor instance that has been created.
     701 * @param {CKEDITOR.editor} editor The editor instance that has been created.
    703702 */
    704703
     
    707706 * @name CKEDITOR#instanceDestroyed
    708707 * @event
    709  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    710  * @param {CKEDITOR.editor} e.editor The editor instance that has been destroyed.
     708 * @param {CKEDITOR.editor} editor The editor instance that has been destroyed.
    711709 */
    712710
     
    715713 * @name CKEDITOR#pluginsLoaded
    716714 * @event
    717  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    718715 */
  • CKEditor/trunk/_source/core/focusmanager.js

    r4905 r4907  
    127127 * @name CKEDITOR.editor#focus
    128128 * @event
    129  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    130  * @param {CKEDITOR.editor} e.editor The editor instance.
     129 * @param {CKEDITOR.editor} editor The editor instance.
    131130 */
    132131
     
    135134 * @name CKEDITOR.editor#blur
    136135 * @event
    137  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    138  * @param {CKEDITOR.editor} e.editor The editor instance.
     136 * @param {CKEDITOR.editor} editor The editor instance.
    139137 */
  • CKEditor/trunk/_source/plugins/clipboard/plugin.js

    r4905 r4907  
    365365 * @since 3.1
    366366 * @event
    367  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    368  * @param {String} [e.data.html] The HTML data to be pasted. If not available, e.data.text will be defined.
    369  * @param {String} [e.data.text] The plain text data to be pasted, available when plain text operations are to used. If not available, e.data.html will be defined.
     367 * @param {String} [data.html] The HTML data to be pasted. If not available, e.data.text will be defined.
     368 * @param {String} [data.text] The plain text data to be pasted, available when plain text operations are to used. If not available, e.data.html will be defined.
    370369 */
  • CKEditor/trunk/_source/plugins/dialog/plugin.js

    r4905 r4907  
    27882788 * @name CKEDITOR#dialogDefinition
    27892789 * @event
    2790  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    2791  * @param {CKEDITOR.dialog.dialogDefinition} e.data The dialog defination that
     2790 * @param {CKEDITOR.dialog.dialogDefinition} data The dialog defination that
    27922791 *              is being loaded.
    2793  * @param {CKEDITOR.editor} e.editor The editor instance that will use the
     2792 * @param {CKEDITOR.editor} editor The editor instance that will use the
    27942793 *              dialog.
    27952794 */
  • CKEditor/trunk/_source/plugins/editingblock/plugin.js

    r4905 r4907  
    240240 * @name CKEDITOR#instanceReady
    241241 * @event
    242  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    243  * @param {CKEDITOR.editor} e.editor The editor instance that has been created.
    244  */
     242 * @param {CKEDITOR.editor} editor The editor instance that has been created.
     243 */
  • CKEditor/trunk/_source/plugins/keystrokes/plugin.js

    r4905 r4907  
    222222 * @name CKEDITOR#key
    223223 * @event
    224  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    225  * @param {Number} e.data.keyCode A number representing the key code (or
     224 * @param {Number} data.keyCode A number representing the key code (or
    226225 *              combination). It is the sum of the current key code and the
    227226 *              {@link CKEDITOR.CTRL}, {@link CKEDITOR.SHIFT} and {@link CKEDITOR.ALT}
  • CKEditor/trunk/_source/plugins/undo/plugin.js

    r4906 r4907  
    510510 * @name CKEDITOR.editor#saveSnapshot
    511511 * @event
    512  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    513512 */
  • CKEditor/trunk/_source/plugins/wysiwygarea/plugin.js

    r4906 r4907  
    851851 * @name CKEDITOR.editor#dataReady
    852852 * @event
    853  * @param {CKEDITOR.eventInfo} e The standard event object passed to listeners.
    854853 */
Note: See TracChangeset for help on using the changeset viewer.
© 2003 – 2015 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy