Qdoc

From jQuery SDK

Contents 1 Document definition 1.1 Text-indent 1.2 Separator line 1.3 Tag structure 2 Tags 2.1 @plugin 2.2 @dependencies 2.3 @entry 2.4 @categories 2.5 @syntax 2.6 @added 2.7 @deprecated 2.8 @removed 2.9 @param 2.10 @return 2.11 @option 2.12 @default 2.13 @description 2.14 @note 2.15 @example 2.16 @js 2.17 @html 2.18 @xml 2.19 @code 2.20 @css 2.21 @results 2.22 @event 2.23 @method

Document definition

Text-indent

5 Tabs á 4 Spaces or 20 Spaces

@example            Write here
                    going on ...

Separator line

The separator has no effect for the documentation, it's only a visual style for a better overview.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Tag structure

key                                  |  optional  |  multiple  |

@plugin
    @dependencies                          x
    @entry                                              x
        @categories
        @syntax                            x            x
            @added
            @deprecated                    x
            @removed                       x
            @param                         x            x
            @return                        x
        @option                            x            x
            @added
            @deprecated                    x
            @removed                       x
            @default                       x
        @description
        @note                              x            x
        @example                                        x
            @js                            x
            @html                          x
            @xml                           x
            @code                          x
            @css                           x
            @results                       x
        @event                             x            x
            @added
            @deprecated                    x
            @removed                       x
        @method                            x            x
            @syntax                                     x
                @added
                @deprecated                x
                @removed                   x
                @param                     x            x
                @return                    x
            @description

Tags

@plugin

Name of the plugin

@plugin             jQuery.cookie

@dependencies

Dependency of plugin 1 | Dependency of plugin N | ...

@dependencies       jQuery.cookie | jQuery.class | jQuery.string

@entry

Name of the entry | Short description | Type of entry

@entry             jQuery.cookie() | Get the value of a cookie. | method

@entry             .sub() | Change the used class. | method

@entry             .jquerysdk | A string containing the jQuery SDK version number. | property

@entry             :readonly | Selects all elements that are readonly. | selector

@entry             border-radius | Set/get CSS border radius. | style

@entry             mousedrag | Bind special event on mouse drag. | event

@entry             Plugin Controller | Configure default values for the plugin/dependencies controller. | config

@categories

Name of the category 1 | Name of the category N | ...

@categories         Data | Form | Events

@syntax

How to call / use

@syntax            jQuery.cookie( key )

@syntax            jQuery.cookie( key, value, [ options ] )

@syntax            .sub( jQuerySubClass )

@syntax            .jquerysdk

@syntax            :readonly

@syntax            border-top-left-radius

@syntax            .bind( 'mousedrag', ... )

@syntax            jQueryConfig.depend[ options ]

@added

Version when added

@added             1.0

@deprecated

Version when deprecated

@added             1.0

@removed

Version when removed

@added             1.0

@param

Name of the parameter | Description of the parameter | [Optional],Type1,TypeN,...

@param              key | A string naming the cookie to get. | String

@param              key | A string naming the cookie to set. | String
@param              value | The new cookie value. | String
@param              options | A map of additional options pass to the method. | Optional,Object

@return

Type of the return value

@return             String

@return             Array

@option

To use @option need to add a @param option to the syntax definition.

Name of the option | Description of the option | [Optional],Type1,TypeN,...

@option             path |  A path prefix to limit the validity of the cookie to a specific path / path prefix. | String

@option             expire | A number of days as storability or an expire date for the cookie. | Optional,Number,Object

@default

Default value of an option

@default            false

@default            ':first-child'

@description

A long description in Qdoc wiki syntax, all html chars will be quoted automatically.

@description        Get a previous stored cookie by a key name.

                    Thanks for this great plugin to [http://stilbuero.de Klaus Hartl].

@note

A note in Qdoc wiki syntax, all html chars will be quoted automatically.

@note               Read more at [http://jquery.com jQuery].

@example

Short description or title of the example

@example            Set some cookies.

@js

A URL to the used javascript file in the example

@js                 http://src.jquerysdk.com/1.0/script/jQuery/core.js

@html

The HTML code of the example.

@html               <div>
                      <ul class="list">
                      </ul>
                    </div>

@xml

The XML code of the example, may be loaded via Ajax.

@xml                <tag>
                      <item optional="true"/>
                      <item optional="false"/>
                    </tag>

@code

Javascript code of the example

@code               // set a cookie
                    $.cookie( 'foo', 'bar' );
                    
                    // get get cookie
                    $.cookie( 'foo' );

@css

CSS used for the example

@css                .selector {
                        display: none;
                    }

@results

Result of the example, this could be a value, HTML or XML

@results            true

@results            <div>
                      <ul class="list">
                        <li>list entry 1</li>
                        <li>list entry 2</li>
                        <li>list entry 3</li>
                        <li>list entry 4</li>
                      </ul>
                    </div>

@event

An event which will triggered from the entry during the run time, especially used for ui widgets.

Name of the event | Short description of the event

@event              change | This event is triggered every time the accordion starts to change.

@method

An available method of the returned object of the entry. Also used for ui widgets.

Name of the method | Short description of the method

@method             destroy | Remove the widget functionality completely.