├── README.md ├── Vsdoc Generator ├── .gitignore ├── Program.cs ├── Properties │ └── AssemblyInfo.cs ├── Vsdoc Generator.csproj ├── Vsdoc Generator.sln ├── bin │ └── Debug │ │ └── .gitignore └── obj │ └── x86 │ └── Debug │ └── .gitignore ├── jquery-1.4.3-vsdoc.js ├── jquery-1.4.4-vsdoc.js ├── jquery.mobile-vsdoc.js └── mock site ├── js ├── JScript.js ├── jquery-1.5-vsdoc.js ├── test-vsdoc.js └── test.js ├── web.config └── working.js /README.md: -------------------------------------------------------------------------------- 1 | ![jQuery VSDoc](http://pub.a2cdn.net/jquery-vsdoc/img/jquery-vsdoc.png "jQuery VsDoc") 2 | --- 3 | 4 | Maintained by [appendTo](http://appendto.com). 5 | jQuery VSDoc [Community Page](http://appendto.com/community/jquery-vsdoc). 6 | 7 | For those new to using Visual Studio with jQuery, the VSDoc version of the file allows Visual Studio to use Intellisense for jQuery development. The VSDoc file contains xml annotations, within javascript comments, which allow Visual Studio to parse, interpret and provide Intellisense while working with Javascript files, and in this case, jQuery. 8 | 9 | If you're still using Visual Studio 2008 and haven't yet updated it with the latest Service Pack, you'll need to do so before being able to make use of the extended Intellisense for Javascript. You can get SP1 for Visual Studio 2008 and Visual Studio 2008 Express [here](http://msdn.microsoft.com/en-us/vstudio/cc533448.aspx). Visual Studio 2010 ships with support for VSDoc. 10 | 11 | As with Intellisense in other languages such as C# and VB.NET, you'll see familiar dialogs / tool windows while writing code, triggered by the same keyboard input as other languages. 12 | 13 | Using jQuery to select divs on a page: 14 | ![VSDoc Example 1](http://pub.a2cdn.net/jquery-vsdoc/img/vsdoc-1.png "VSDoc Example 1") 15 | 16 | Intellisense for chained methods: 17 | ![VSDoc Example 2](http://pub.a2cdn.net/jquery-vsdoc/img/vsdoc-2.png "VSDoc Example 2") 18 | 19 | Inspecting the arguments of a method: 20 | ![VSDoc Example 3](http://pub.a2cdn.net/jquery-vsdoc/img/vsdoc-3.png "VSDoc Example 3") 21 | 22 | For more information on using the jQuery VSDoc and Javascript Intellisense, please visit [Scott Guthrie's original post](http://weblogs.asp.net/scottgu/archive/2008/11/21/jquery-intellisense-in-vs-2008.aspx), Jeff King's original "Rich Intellisense for jQuery" post (http://blogs.msdn.com/b/webdevtools/archive/2008/10/28/rich-intellisense-for-jquery.aspx), [Rick Strahl's post](http://www.west-wind.com/Weblog/posts/536756.aspx), or Ralph Whitbeck's [Learning jQuery blog post](http://www.learningjquery.com/2009/07/setting-up-visual-studio-intellisense-for-jquery). -------------------------------------------------------------------------------- /Vsdoc Generator/.gitignore: -------------------------------------------------------------------------------- 1 | /*.suo 2 | -------------------------------------------------------------------------------- /Vsdoc Generator/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.IO; 4 | using System.Linq; 5 | using System.Net; 6 | using System.Text; 7 | using System.Xml; 8 | using System.Xml.Linq; 9 | 10 | namespace Vsdoc_Generator { 11 | 12 | public static class Extensions { 13 | 14 | public static void AddRange(this IDictionary D, IEnumerable> V) { 15 | foreach (var kvp in V) { 16 | if (D.ContainsKey(kvp.Key)) { 17 | throw new ArgumentException("An item with the same key has already been added."); 18 | } 19 | D.Add(kvp); 20 | } 21 | } 22 | } 23 | 24 | class Program { 25 | 26 | static XmlNodeList categories = null; 27 | static List staticMethods = new List(); 28 | static List instanceMethods = new List(); 29 | static List jQuery = new List(); 30 | static Dictionary reservedWords; 31 | 32 | static void Main(string[] args) { 33 | 34 | InitReservedWords(); 35 | 36 | String apiXml = String.Empty; 37 | XmlDocument xml = new XmlDocument(); 38 | 39 | using (WebClient client = new WebClient()) { 40 | apiXml = client.DownloadString("http://api.jquery.com/api"); 41 | } 42 | 43 | xml.LoadXml(apiXml); 44 | 45 | categories = xml.SelectNodes("api/categories"); 46 | 47 | foreach (XmlNode method in xml.SelectNodes(@"api/entries/entry[@type='method']")) { 48 | String name = method.Attributes["name"].Value; 49 | 50 | if (name == "jQuery") { 51 | jQuery.Add(method); 52 | } 53 | else if (name.StartsWith("jQuery.")) { 54 | staticMethods.Add(method); 55 | } 56 | else { 57 | if (!name.StartsWith("event.")) { // ignore the event.* "methods" that are in the docs. these should really be properties. 58 | instanceMethods.Add(method); 59 | } 60 | } 61 | 62 | } 63 | 64 | using (FileStream fs = new FileStream("jquery-1.5-vsdoc.js", FileMode.Create, FileAccess.ReadWrite)) { 65 | using (StreamWriter sw = new StreamWriter(fs)) { 66 | sw.Write(Render()); 67 | } 68 | } 69 | 70 | } 71 | 72 | static String Render() { 73 | 74 | StringBuilder sb = new StringBuilder(); 75 | String output = String.Empty; 76 | List methodOutput = new List(); 77 | 78 | // = \n 79 | // - tab 80 | 81 | foreach (XmlElement method in instanceMethods) { 82 | methodOutput.Add(RenderMethod(method, true)); 83 | } 84 | 85 | sb.Append(RenderJQuery()); 86 | sb.Append("$.fn = $.prototype = {\n"); 87 | sb.Append(String.Join(", ", methodOutput.ToArray())); 88 | sb.Append("\n};\n"); 89 | 90 | foreach (XmlElement method in staticMethods) { 91 | sb.Append(RenderMethod(method, false)); 92 | } 93 | 94 | return sb.ToString(); 95 | } 96 | 97 | static String RenderMethod(XmlElement method, Boolean instance) { 98 | 99 | StringBuilder sb = new StringBuilder(); 100 | String name = method.Attributes["name"].Value; 101 | String summary = RenderSummary(method, name); 102 | String returns = RenderReturn(method); 103 | String @params = RenderParams(method); 104 | String arguments = String.Empty; 105 | String opening, closing = String.Empty; 106 | XmlNodeList signatures = method.SelectNodes("signature"); 107 | 108 | if (signatures.Count > 0) { 109 | XmlNode signature = signatures[0]; 110 | arguments = BuildArguments(signature, false); 111 | } 112 | 113 | if (instance) { 114 | opening = String.Concat("\n\t", name, ": function(", arguments, "){\n"); 115 | closing = "\t}"; 116 | } 117 | else { 118 | opening = String.Concat("\n", name, " = function(", arguments, "){\n"); 119 | closing = "};"; 120 | } 121 | 122 | sb.Append(opening); 123 | sb.Append(summary); 124 | sb.Append(@params); 125 | sb.Append(returns); 126 | sb.Append(closing); 127 | 128 | return sb.ToString(); 129 | } 130 | 131 | static String RenderSummary(XmlElement method, String name) { 132 | 133 | StringBuilder sb = new StringBuilder(); 134 | XmlNode desc = method.SelectSingleNode("desc"); 135 | XmlNodeList signatures = method.SelectNodes("signature"); 136 | String methodName = name.StartsWith("jQuery") ? name : String.Concat(".", name); 137 | 138 | if (desc == null) { 139 | desc = signatures[0].SelectSingleNode("desc"); 140 | } 141 | 142 | sb.Append("\t\t/// \n\t\t/// \t"); 143 | sb.Append(desc.InnerText); 144 | sb.Append("\n"); 145 | 146 | if (signatures.Count > 1) { 147 | sb.Append("\t\t/// \t Additional Signatures:\n"); 148 | 149 | for (int i = 1; i < signatures.Count; i++) { 150 | XmlNode signature = signatures[i]; 151 | String arguments = BuildArguments(signature, true); 152 | 153 | sb.Append(String.Format("\t\t/// \t {0}. {1}( {2} )\n", i.ToString(), methodName, arguments)); 154 | } 155 | 156 | } 157 | 158 | sb.Append(String.Concat("\t\t/// \t API Reference: http://api.jquery.com/", name)); 159 | sb.Append("\n\t\t/// \n"); 160 | 161 | return sb.ToString(); 162 | 163 | } 164 | 165 | static String RenderParams(XmlElement method) { 166 | 167 | StringBuilder sb = new StringBuilder(); 168 | XmlNodeList signatures = method.SelectNodes("signature"); 169 | 170 | if (signatures.Count == 0) { 171 | return String.Empty; 172 | } 173 | 174 | XmlNode signature = signatures[0]; 175 | XmlNodeList args = signature.SelectNodes("argument"); 176 | int dupe = 1; 177 | List arugmentNames = new List(); 178 | 179 | foreach (XmlElement arg in args) { 180 | String desc = arg.SelectSingleNode("desc").InnerText; 181 | String type = arg.HasAttribute("type") ? arg.Attributes["type"].Value : String.Empty; 182 | String name = arg.Attributes["name"].Value; 183 | String optional = arg.HasAttribute("optional") ? " optional=\"true\"" : String.Empty; 184 | String integer = type.ToLower() == "integer" ? " integer=\"true\"" : String.Empty; 185 | 186 | //if (name == "function") { 187 | // name = "method"; 188 | //} 189 | name = ReplaceReservedWord(name); 190 | 191 | if (type == "Function" && name.Contains("(")) { 192 | if (name.Contains("handler")) { 193 | name = "handler"; 194 | } 195 | else { 196 | name = "method"; 197 | } 198 | } 199 | 200 | if (arugmentNames.Contains(name)) { 201 | name = String.Concat(name, dupe.ToString()); 202 | dupe++; 203 | } 204 | 205 | arugmentNames.Add(name); 206 | 207 | String param = String.Format("\t\t/// \n\t\t/// \t{4}\n\t\t/// \n", name, ResolveType(type), optional, integer, desc); 208 | 209 | sb.Append(param); 210 | } 211 | 212 | return sb.ToString(); 213 | } 214 | 215 | static String RenderReturn(XmlElement method) { 216 | String returnType = String.Empty; 217 | 218 | if (method.HasAttribute("return")) { 219 | returnType = method.Attributes["return"].Value; 220 | } 221 | 222 | if (String.IsNullOrEmpty(returnType)) { 223 | return String.Empty; 224 | } 225 | 226 | return String.Concat("\t\t/// \n"); 227 | } 228 | 229 | static String RenderJQuery() { 230 | 231 | XmlElement baseNode = jQuery[0] as XmlElement; 232 | String arguments = BuildArguments(baseNode.SelectNodes("signature")[0], false); 233 | StringBuilder sb = new StringBuilder(String.Concat("var jQuery = $ = function(", arguments, "){\n")); 234 | 235 | // for some reason the xml documentation has the jQuery method's signatures split between three entries (for 1.4.4) 236 | // combine them into one entry for processing. 237 | for (int i = 1; i < jQuery.Count; i++) { 238 | foreach (XmlNode signature in jQuery[i].SelectNodes("signature")) { 239 | baseNode.AppendChild(signature); 240 | } 241 | } 242 | 243 | String summary = RenderSummary(baseNode, "jQuery"); 244 | String returns = RenderReturn(baseNode); 245 | String @params = RenderParams(baseNode); 246 | 247 | sb.Append(summary); 248 | sb.Append(@params); 249 | sb.Append(returns); 250 | sb.Append("};\n"); 251 | 252 | return sb.ToString(); 253 | } 254 | 255 | static String ResolveType(String type) { 256 | 257 | if (type.Contains(",")) { 258 | return type.Split(',').Last().Trim(); 259 | } 260 | 261 | if (type.Contains("/")) { 262 | return type.Split('/').Last().Trim(); 263 | } 264 | 265 | if (type == "Callback") { 266 | return "Function"; 267 | } 268 | 269 | if ((new[] { "Options", "Map", "Any" }).Contains(type)) { 270 | return "Object"; 271 | } 272 | 273 | if (type.Equals("selector", StringComparison.OrdinalIgnoreCase) || type.Equals("HTML", StringComparison.OrdinalIgnoreCase)) { 274 | return "String"; 275 | } 276 | 277 | if (type == "Integer") { 278 | return "Number"; 279 | } 280 | 281 | if (type == "Elements") { 282 | return "Array"; 283 | } 284 | 285 | if (type == "boolean") { // normalize mismatched cases 286 | return "Boolean"; 287 | } 288 | 289 | return type; 290 | 291 | } 292 | 293 | static String BuildArguments(XmlNode signature, Boolean wrapOptional) { 294 | 295 | List arguments = new List(); 296 | XmlNodeList args = signature.SelectNodes("argument"); 297 | int dupe = 1; 298 | 299 | foreach (XmlElement arg in args) { 300 | String name = arg.Attributes["name"].Value; 301 | String type = arg.HasAttribute("type") ? ResolveType(arg.Attributes["type"].Value) : String.Empty; 302 | 303 | if (name == "function") { 304 | name = "method"; 305 | } 306 | 307 | if (type == "Function" && name.Contains("(")) { 308 | if (name.Contains("handler")) { 309 | name = "handler"; 310 | } 311 | else { 312 | name = "method"; 313 | } 314 | } 315 | 316 | if (arguments.Contains(name)) { 317 | name = String.Concat(name, dupe.ToString()); 318 | dupe++; 319 | } 320 | 321 | if (arg.HasAttribute("optional") && wrapOptional) { 322 | name = String.Concat("[", name, "]"); 323 | } 324 | 325 | arguments.Add(name); 326 | } 327 | 328 | return String.Join(", ", arguments.ToArray()); 329 | } 330 | 331 | static void InitReservedWords() { 332 | 333 | reservedWords = new Dictionary() { 334 | { "break", String.Empty }, 335 | { "case", "kase" }, 336 | { "catch", String.Empty }, 337 | { "continue", String.Empty }, 338 | { "debugger", String.Empty }, 339 | { "default", String.Empty }, 340 | { "delete", String.Empty }, 341 | { "do", String.Empty }, 342 | { "else", String.Empty }, 343 | { "finally", String.Empty }, 344 | { "for", "_for" }, 345 | { "function", "method" }, 346 | { "if", String.Empty }, 347 | { "in", String.Empty }, 348 | { "instanceof", String.Empty }, 349 | { "new", String.Empty }, 350 | { "return", String.Empty }, 351 | { "switch", String.Empty }, 352 | { "this", String.Empty }, 353 | { "throw", String.Empty }, 354 | { "try", String.Empty }, 355 | { "typeof", String.Empty }, 356 | { "var", String.Empty }, 357 | { "void", String.Empty }, 358 | { "while", String.Empty }, 359 | { "with", String.Empty }, 360 | { "class", "klass" }, 361 | { "enum", String.Empty }, 362 | { "export", String.Empty }, 363 | { "extends", String.Empty }, 364 | { "import", String.Empty }, 365 | { "super", String.Empty }, 366 | { "implements", String.Empty }, 367 | { "interface", String.Empty }, 368 | { "let", String.Empty }, 369 | { "package", String.Empty }, 370 | { "private", String.Empty }, 371 | { "protected", String.Empty }, 372 | { "public", String.Empty }, 373 | { "static", String.Empty }, 374 | { "yield", String.Empty } 375 | }; 376 | 377 | } 378 | 379 | /// 380 | /// Resolves any conflicts with reserved words. 381 | /// The jQuery docs aren't exactly consistent, many functions in the docs use reserve words for parameter names. 382 | /// 383 | /// 384 | /// 385 | static String ReplaceReservedWord(String word) { 386 | 387 | String result = word; 388 | 389 | if (reservedWords.ContainsKey(word)) { 390 | String replacement = reservedWords[word]; 391 | 392 | if (String.IsNullOrEmpty(replacement)) { 393 | replacement = String.Concat("_", word); 394 | } 395 | 396 | result = replacement; 397 | } 398 | 399 | return result; 400 | 401 | } 402 | } 403 | 404 | } 405 | -------------------------------------------------------------------------------- /Vsdoc Generator/Properties/AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | using System.Reflection; 2 | using System.Runtime.CompilerServices; 3 | using System.Runtime.InteropServices; 4 | 5 | // General Information about an assembly is controlled through the following 6 | // set of attributes. Change these attribute values to modify the information 7 | // associated with an assembly. 8 | [assembly: AssemblyTitle("Vsdoc Generator")] 9 | [assembly: AssemblyDescription("")] 10 | [assembly: AssemblyConfiguration("")] 11 | [assembly: AssemblyCompany("")] 12 | [assembly: AssemblyProduct("Vsdoc Generator")] 13 | [assembly: AssemblyCopyright("Copyright © 2010")] 14 | [assembly: AssemblyTrademark("")] 15 | [assembly: AssemblyCulture("")] 16 | 17 | // Setting ComVisible to false makes the types in this assembly not visible 18 | // to COM components. If you need to access a type in this assembly from 19 | // COM, set the ComVisible attribute to true on that type. 20 | [assembly: ComVisible(false)] 21 | 22 | // The following GUID is for the ID of the typelib if this project is exposed to COM 23 | [assembly: Guid("0da04ead-1871-4204-93d3-4d56ad3e71a5")] 24 | 25 | // Version information for an assembly consists of the following four values: 26 | // 27 | // Major Version 28 | // Minor Version 29 | // Build Number 30 | // Revision 31 | // 32 | // You can specify all the values or you can default the Build and Revision Numbers 33 | // by using the '*' as shown below: 34 | // [assembly: AssemblyVersion("1.0.*")] 35 | [assembly: AssemblyVersion("1.0.0.0")] 36 | [assembly: AssemblyFileVersion("1.0.0.0")] 37 | -------------------------------------------------------------------------------- /Vsdoc Generator/Vsdoc Generator.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | Debug 5 | x86 6 | 8.0.30703 7 | 2.0 8 | {8569C8F9-3B35-4EF1-80C7-ED864FDD02BD} 9 | Exe 10 | Properties 11 | Vsdoc_Generator 12 | Vsdoc Generator 13 | v4.0 14 | Client 15 | 512 16 | 17 | 18 | x86 19 | true 20 | full 21 | false 22 | bin\Debug\ 23 | DEBUG;TRACE 24 | prompt 25 | 4 26 | 27 | 28 | x86 29 | pdbonly 30 | true 31 | bin\Release\ 32 | TRACE 33 | prompt 34 | 4 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 57 | -------------------------------------------------------------------------------- /Vsdoc Generator/Vsdoc Generator.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 11.00 3 | # Visual Studio 2010 4 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Vsdoc Generator", "Vsdoc Generator.csproj", "{8569C8F9-3B35-4EF1-80C7-ED864FDD02BD}" 5 | EndProject 6 | Global 7 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 8 | Debug|x86 = Debug|x86 9 | Release|x86 = Release|x86 10 | EndGlobalSection 11 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 12 | {8569C8F9-3B35-4EF1-80C7-ED864FDD02BD}.Debug|x86.ActiveCfg = Debug|x86 13 | {8569C8F9-3B35-4EF1-80C7-ED864FDD02BD}.Debug|x86.Build.0 = Debug|x86 14 | {8569C8F9-3B35-4EF1-80C7-ED864FDD02BD}.Release|x86.ActiveCfg = Release|x86 15 | {8569C8F9-3B35-4EF1-80C7-ED864FDD02BD}.Release|x86.Build.0 = Release|x86 16 | EndGlobalSection 17 | GlobalSection(SolutionProperties) = preSolution 18 | HideSolutionNode = FALSE 19 | EndGlobalSection 20 | EndGlobal 21 | -------------------------------------------------------------------------------- /Vsdoc Generator/bin/Debug/.gitignore: -------------------------------------------------------------------------------- 1 | /Vsdoc Generator.exe 2 | /Vsdoc Generator.pdb 3 | /Vsdoc Generator.vshost.exe 4 | /Vsdoc Generator.vshost.exe.manifest 5 | /jquery-1.4.4-vsdoc.js 6 | -------------------------------------------------------------------------------- /Vsdoc Generator/obj/x86/Debug/.gitignore: -------------------------------------------------------------------------------- 1 | /DesignTimeResolveAssemblyReferencesInput.cache 2 | /ResolveAssemblyReference.cache 3 | /Vsdoc Generator.csproj.FileListAbsolute.txt 4 | /Vsdoc Generator.exe 5 | /Vsdoc Generator.pdb 6 | -------------------------------------------------------------------------------- /jquery-1.4.4-vsdoc.js: -------------------------------------------------------------------------------- 1 | var jQuery = $ = function(selector, context){ 2 | /// 3 | /// Accepts a string containing a CSS selector which is then used to match a set of elements. 4 | /// Additional Signatures: 5 | /// 1. jQuery( element ) 6 | /// 2. jQuery( elementArray ) 7 | /// 3. jQuery( jQuery object ) 8 | /// 4. jQuery( ) 9 | /// 5. jQuery( html, [ownerDocument] ) 10 | /// 6. jQuery( html, props ) 11 | /// 7. jQuery( callback ) 12 | /// API Reference: http://api.jquery.com/jQuery 13 | /// 14 | /// 15 | /// A string containing a selector expression 16 | /// 17 | /// 18 | /// A DOM Element, Document, or jQuery to use as context 19 | /// 20 | /// 21 | }; 22 | $.prototype = { 23 | 24 | fadeToggle: function(duration, easing, callback){ 25 | /// 26 | /// Display or hide the matched elements by animating their opacity. 27 | /// API Reference: http://api.jquery.com/fadeToggle 28 | /// 29 | /// 30 | /// A string or number determining how long the animation will run. 31 | /// 32 | /// 33 | /// A string indicating which easing function to use for the transition. 34 | /// 35 | /// 36 | /// A function to call once the animation is complete. 37 | /// 38 | /// 39 | }, 40 | toggle: function(handler, handler1, handler2){ 41 | /// 42 | /// Bind two or more handlers to the matched elements, to be executed on alternate clicks. 43 | /// API Reference: http://api.jquery.com/toggle 44 | /// 45 | /// 46 | /// A function to execute every even time the element is clicked. 47 | /// 48 | /// 49 | /// A function to execute every odd time the element is clicked. 50 | /// 51 | /// 52 | /// Additional handlers to cycle through after clicks. 53 | /// 54 | /// 55 | }, 56 | undelegate: function(){ 57 | /// 58 | /// Remove a handler from the event for all elements which match the current selector, now or in the future, based upon a specific set of root elements. 59 | /// Additional Signatures: 60 | /// 1. .undelegate( selector, eventType ) 61 | /// 2. .undelegate( selector, eventType, handler ) 62 | /// API Reference: http://api.jquery.com/undelegate 63 | /// 64 | /// 65 | }, 66 | delegate: function(selector, eventType, handler){ 67 | /// 68 | /// Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements. 69 | /// Additional Signatures: 70 | /// 1. .delegate( selector, eventType, eventData, handler ) 71 | /// API Reference: http://api.jquery.com/delegate 72 | /// 73 | /// 74 | /// A selector to filter the elements that trigger the event. 75 | /// 76 | /// 77 | /// A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," or custom event names. 78 | /// 79 | /// 80 | /// A function to execute at the time the event is triggered. 81 | /// 82 | /// 83 | }, 84 | focusout: function(handler){ 85 | /// 86 | /// Bind an event handler to the "focusout" JavaScript event. 87 | /// Additional Signatures: 88 | /// 1. .focusout( [eventData], handler ) 89 | /// API Reference: http://api.jquery.com/focusout 90 | /// 91 | /// 92 | /// A function to execute each time the event is triggered. 93 | /// 94 | /// 95 | }, 96 | focusin: function(handler){ 97 | /// 98 | /// Bind an event handler to the "focusin" JavaScript event. 99 | /// Additional Signatures: 100 | /// 1. .focusin( [eventData], handler ) 101 | /// API Reference: http://api.jquery.com/focusin 102 | /// 103 | /// 104 | /// A function to execute each time the event is triggered. 105 | /// 106 | /// 107 | }, 108 | has: function(selector){ 109 | /// 110 | /// Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element. 111 | /// Additional Signatures: 112 | /// 1. .has( contained ) 113 | /// API Reference: http://api.jquery.com/has 114 | /// 115 | /// 116 | /// A string containing a selector expression to match elements against. 117 | /// 118 | /// 119 | }, 120 | delay: function(duration, queueName){ 121 | /// 122 | /// Set a timer to delay execution of subsequent items in the queue. 123 | /// API Reference: http://api.jquery.com/delay 124 | /// 125 | /// 126 | /// An integer indicating the number of milliseconds to delay execution of the next item in the queue. 127 | /// 128 | /// 129 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 130 | /// 131 | /// 132 | }, 133 | parentsUntil: function(selector){ 134 | /// 135 | /// Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector. 136 | /// API Reference: http://api.jquery.com/parentsUntil 137 | /// 138 | /// 139 | /// A string containing a selector expression to indicate where to stop matching ancestor elements. 140 | /// 141 | /// 142 | }, 143 | prevUntil: function(selector){ 144 | /// 145 | /// Get all preceding siblings of each element up to but not including the element matched by the selector. 146 | /// API Reference: http://api.jquery.com/prevUntil 147 | /// 148 | /// 149 | /// A string containing a selector expression to indicate where to stop matching preceding sibling elements. 150 | /// 151 | /// 152 | }, 153 | nextUntil: function(selector){ 154 | /// 155 | /// Get all following siblings of each element up to but not including the element matched by the selector. 156 | /// API Reference: http://api.jquery.com/nextUntil 157 | /// 158 | /// 159 | /// A string containing a selector expression to indicate where to stop matching following sibling elements. 160 | /// 161 | /// 162 | }, 163 | each: function(method){ 164 | /// 165 | /// Iterate over a jQuery object, executing a function for each matched element. 166 | /// API Reference: http://api.jquery.com/each 167 | /// 168 | /// 169 | /// A function to execute for each matched element. 170 | /// 171 | /// 172 | }, 173 | pushStack: function(elements){ 174 | /// 175 | /// Add a collection of DOM elements onto the jQuery stack. 176 | /// Additional Signatures: 177 | /// 1. .pushStack( elements, name, arguments ) 178 | /// API Reference: http://api.jquery.com/pushStack 179 | /// 180 | /// 181 | /// An array of elements to push onto the stack and make into a new jQuery object. 182 | /// 183 | /// 184 | }, 185 | clearQueue: function(queueName){ 186 | /// 187 | /// Remove from the queue all items that have not yet been run. 188 | /// API Reference: http://api.jquery.com/clearQueue 189 | /// 190 | /// 191 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 192 | /// 193 | /// 194 | }, 195 | toArray: function(){ 196 | /// 197 | /// Retrieve all the DOM elements contained in the jQuery set, as an array. 198 | /// API Reference: http://api.jquery.com/toArray 199 | /// 200 | /// 201 | }, 202 | keydown: function(handler){ 203 | /// 204 | /// Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element. 205 | /// Additional Signatures: 206 | /// 1. .keydown( [eventData], handler ) 207 | /// 2. .keydown( ) 208 | /// API Reference: http://api.jquery.com/keydown 209 | /// 210 | /// 211 | /// A function to execute each time the event is triggered. 212 | /// 213 | /// 214 | }, 215 | index: function(){ 216 | /// 217 | /// Search for a given element from among the matched elements. 218 | /// Additional Signatures: 219 | /// 1. .index( selector ) 220 | /// 2. .index( element ) 221 | /// API Reference: http://api.jquery.com/index 222 | /// 223 | /// 224 | }, 225 | removeData: function(name){ 226 | /// 227 | /// Remove a previously-stored piece of data. 228 | /// API Reference: http://api.jquery.com/removeData 229 | /// 230 | /// 231 | /// A string naming the piece of data to delete. 232 | /// 233 | /// 234 | }, 235 | data: function(key, value){ 236 | /// 237 | /// Store arbitrary data associated with the matched elements. 238 | /// Additional Signatures: 239 | /// 1. .data( obj ) 240 | /// API Reference: http://api.jquery.com/data 241 | /// 242 | /// 243 | /// A string naming the piece of data to set. 244 | /// 245 | /// 246 | /// The new data value; it can be any Javascript type including Array or Object. 247 | /// 248 | /// 249 | }, 250 | data: function(key){ 251 | /// 252 | /// Returns value at named data store for the first element in the jQuery collection, as set by data(name, value). 253 | /// Additional Signatures: 254 | /// 1. .data( ) 255 | /// API Reference: http://api.jquery.com/data 256 | /// 257 | /// 258 | /// Name of the data stored. 259 | /// 260 | /// 261 | }, 262 | get: function(index){ 263 | /// 264 | /// Retrieve the DOM elements matched by the jQuery object. 265 | /// API Reference: http://api.jquery.com/get 266 | /// 267 | /// 268 | /// A zero-based integer indicating which element to retrieve. 269 | /// 270 | /// 271 | }, 272 | size: function(){ 273 | /// 274 | /// Return the number of DOM elements matched by the jQuery object. 275 | /// API Reference: http://api.jquery.com/size 276 | /// 277 | /// 278 | }, 279 | scroll: function(handler){ 280 | /// 281 | /// Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element. 282 | /// Additional Signatures: 283 | /// 1. .scroll( [eventData], handler ) 284 | /// 2. .scroll( ) 285 | /// API Reference: http://api.jquery.com/scroll 286 | /// 287 | /// 288 | /// A function to execute each time the event is triggered. 289 | /// 290 | /// 291 | }, 292 | resize: function(handler){ 293 | /// 294 | /// Bind an event handler to the "resize" JavaScript event, or trigger that event on an element. 295 | /// Additional Signatures: 296 | /// 1. .resize( [eventData], handler ) 297 | /// 2. .resize( ) 298 | /// API Reference: http://api.jquery.com/resize 299 | /// 300 | /// 301 | /// A function to execute each time the event is triggered. 302 | /// 303 | /// 304 | }, 305 | dequeue: function(queueName){ 306 | /// 307 | /// Execute the next function on the queue for the matched elements. 308 | /// API Reference: http://api.jquery.com/dequeue 309 | /// 310 | /// 311 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 312 | /// 313 | /// 314 | }, 315 | queue: function(queueName){ 316 | /// 317 | /// Show the queue of functions to be executed on the matched elements. 318 | /// API Reference: http://api.jquery.com/queue 319 | /// 320 | /// 321 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 322 | /// 323 | /// 324 | }, 325 | queue: function(queueName, newQueue){ 326 | /// 327 | /// Manipulate the queue of functions to be executed on the matched elements. 328 | /// Additional Signatures: 329 | /// 1. .queue( [queueName], method ) 330 | /// API Reference: http://api.jquery.com/queue 331 | /// 332 | /// 333 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 334 | /// 335 | /// 336 | /// An array of functions to replace the current queue contents. 337 | /// 338 | /// 339 | }, 340 | keyup: function(handler){ 341 | /// 342 | /// Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element. 343 | /// Additional Signatures: 344 | /// 1. .keyup( [eventData], handler ) 345 | /// 2. .keyup( ) 346 | /// API Reference: http://api.jquery.com/keyup 347 | /// 348 | /// 349 | /// A function to execute each time the event is triggered. 350 | /// 351 | /// 352 | }, 353 | keypress: function(handler){ 354 | /// 355 | /// Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element. 356 | /// Additional Signatures: 357 | /// 1. .keypress( [eventData], handler ) 358 | /// 2. .keypress( ) 359 | /// API Reference: http://api.jquery.com/keypress 360 | /// 361 | /// 362 | /// A function to execute each time the event is triggered. 363 | /// 364 | /// 365 | }, 366 | submit: function(handler){ 367 | /// 368 | /// Bind an event handler to the "submit" JavaScript event, or trigger that event on an element. 369 | /// Additional Signatures: 370 | /// 1. .submit( [eventData], handler ) 371 | /// 2. .submit( ) 372 | /// API Reference: http://api.jquery.com/submit 373 | /// 374 | /// 375 | /// A function to execute each time the event is triggered. 376 | /// 377 | /// 378 | }, 379 | select: function(handler){ 380 | /// 381 | /// Bind an event handler to the "select" JavaScript event, or trigger that event on an element. 382 | /// Additional Signatures: 383 | /// 1. .select( [eventData], handler ) 384 | /// 2. .select( ) 385 | /// API Reference: http://api.jquery.com/select 386 | /// 387 | /// 388 | /// A function to execute each time the event is triggered. 389 | /// 390 | /// 391 | }, 392 | change: function(handler){ 393 | /// 394 | /// Bind an event handler to the "change" JavaScript event, or trigger that event on an element. 395 | /// Additional Signatures: 396 | /// 1. .change( [eventData], handler ) 397 | /// 2. .change( ) 398 | /// API Reference: http://api.jquery.com/change 399 | /// 400 | /// 401 | /// A function to execute each time the event is triggered. 402 | /// 403 | /// 404 | }, 405 | blur: function(handler){ 406 | /// 407 | /// Bind an event handler to the "blur" JavaScript event, or trigger that event on an element. 408 | /// Additional Signatures: 409 | /// 1. .blur( [eventData], handler ) 410 | /// 2. .blur( ) 411 | /// API Reference: http://api.jquery.com/blur 412 | /// 413 | /// 414 | /// A function to execute each time the event is triggered. 415 | /// 416 | /// 417 | }, 418 | focus: function(handler){ 419 | /// 420 | /// Bind an event handler to the "focus" JavaScript event, or trigger that event on an element. 421 | /// Additional Signatures: 422 | /// 1. .focus( [eventData], handler ) 423 | /// 2. .focus( ) 424 | /// API Reference: http://api.jquery.com/focus 425 | /// 426 | /// 427 | /// A function to execute each time the event is triggered. 428 | /// 429 | /// 430 | }, 431 | mousemove: function(handler){ 432 | /// 433 | /// Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element. 434 | /// Additional Signatures: 435 | /// 1. .mousemove( [eventData], handler ) 436 | /// 2. .mousemove( ) 437 | /// API Reference: http://api.jquery.com/mousemove 438 | /// 439 | /// 440 | /// A function to execute each time the event is triggered. 441 | /// 442 | /// 443 | }, 444 | hover: function(handler, handler1){ 445 | /// 446 | /// Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements. 447 | /// API Reference: http://api.jquery.com/hover 448 | /// 449 | /// 450 | /// A function to execute when the mouse pointer enters the element. 451 | /// 452 | /// 453 | /// A function to execute when the mouse pointer leaves the element. 454 | /// 455 | /// 456 | }, 457 | hover: function(handler){ 458 | /// 459 | /// Bind a single handler to the matched elements, to be executed when the mouse pointer enters or leaves the elements. 460 | /// API Reference: http://api.jquery.com/hover 461 | /// 462 | /// 463 | /// A function to execute when the mouse pointer enters or leaves the element. 464 | /// 465 | /// 466 | }, 467 | mouseleave: function(handler){ 468 | /// 469 | /// Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element. 470 | /// Additional Signatures: 471 | /// 1. .mouseleave( [eventData], handler ) 472 | /// 2. .mouseleave( ) 473 | /// API Reference: http://api.jquery.com/mouseleave 474 | /// 475 | /// 476 | /// A function to execute each time the event is triggered. 477 | /// 478 | /// 479 | }, 480 | mouseenter: function(handler){ 481 | /// 482 | /// Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element. 483 | /// Additional Signatures: 484 | /// 1. .mouseenter( [eventData], handler ) 485 | /// 2. .mouseenter( ) 486 | /// API Reference: http://api.jquery.com/mouseenter 487 | /// 488 | /// 489 | /// A function to execute each time the event is triggered. 490 | /// 491 | /// 492 | }, 493 | mouseout: function(handler){ 494 | /// 495 | /// Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element. 496 | /// Additional Signatures: 497 | /// 1. .mouseout( [eventData], handler ) 498 | /// 2. .mouseout( ) 499 | /// API Reference: http://api.jquery.com/mouseout 500 | /// 501 | /// 502 | /// A function to execute each time the event is triggered. 503 | /// 504 | /// 505 | }, 506 | mouseover: function(handler){ 507 | /// 508 | /// Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element. 509 | /// Additional Signatures: 510 | /// 1. .mouseover( [eventData], handler ) 511 | /// 2. .mouseover( ) 512 | /// API Reference: http://api.jquery.com/mouseover 513 | /// 514 | /// 515 | /// A function to execute each time the event is triggered. 516 | /// 517 | /// 518 | }, 519 | dblclick: function(handler){ 520 | /// 521 | /// Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element. 522 | /// Additional Signatures: 523 | /// 1. .dblclick( [eventData], handler ) 524 | /// 2. .dblclick( ) 525 | /// API Reference: http://api.jquery.com/dblclick 526 | /// 527 | /// 528 | /// A function to execute each time the event is triggered. 529 | /// 530 | /// 531 | }, 532 | click: function(handler){ 533 | /// 534 | /// Bind an event handler to the "click" JavaScript event, or trigger that event on an element. 535 | /// Additional Signatures: 536 | /// 1. .click( [eventData], handler ) 537 | /// 2. .click( ) 538 | /// API Reference: http://api.jquery.com/click 539 | /// 540 | /// 541 | /// A function to execute each time the event is triggered. 542 | /// 543 | /// 544 | }, 545 | mouseup: function(handler){ 546 | /// 547 | /// Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element. 548 | /// Additional Signatures: 549 | /// 1. .mouseup( [eventData], handler ) 550 | /// 2. .mouseup( ) 551 | /// API Reference: http://api.jquery.com/mouseup 552 | /// 553 | /// 554 | /// A function to execute each time the event is triggered. 555 | /// 556 | /// 557 | }, 558 | mousedown: function(handler){ 559 | /// 560 | /// Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element. 561 | /// Additional Signatures: 562 | /// 1. .mousedown( [eventData], handler ) 563 | /// 2. .mousedown( ) 564 | /// API Reference: http://api.jquery.com/mousedown 565 | /// 566 | /// 567 | /// A function to execute each time the event is triggered. 568 | /// 569 | /// 570 | }, 571 | error: function(handler){ 572 | /// 573 | /// Bind an event handler to the "error" JavaScript event. 574 | /// Additional Signatures: 575 | /// 1. .error( [eventData], handler ) 576 | /// API Reference: http://api.jquery.com/error 577 | /// 578 | /// 579 | /// A function to execute when the event is triggered. 580 | /// 581 | /// 582 | }, 583 | unload: function(handler){ 584 | /// 585 | /// Bind an event handler to the "unload" JavaScript event. 586 | /// Additional Signatures: 587 | /// 1. .unload( [eventData], handler ) 588 | /// API Reference: http://api.jquery.com/unload 589 | /// 590 | /// 591 | /// A function to execute when the event is triggered. 592 | /// 593 | /// 594 | }, 595 | load: function(handler){ 596 | /// 597 | /// Bind an event handler to the "load" JavaScript event. 598 | /// Additional Signatures: 599 | /// 1. .load( [eventData], handler ) 600 | /// API Reference: http://api.jquery.com/load 601 | /// 602 | /// 603 | /// A function to execute when the event is triggered. 604 | /// 605 | /// 606 | }, 607 | ready: function(handler){ 608 | /// 609 | /// Specify a function to execute when the DOM is fully loaded. 610 | /// API Reference: http://api.jquery.com/ready 611 | /// 612 | /// 613 | /// A function to execute after the DOM is ready. 614 | /// 615 | /// 616 | }, 617 | die: function(){ 618 | /// 619 | /// Remove all event handlers previously attached using .live() from the elements. 620 | /// API Reference: http://api.jquery.com/die 621 | /// 622 | /// 623 | }, 624 | die: function(eventType, handler){ 625 | /// 626 | /// Remove an event handler previously attached using .live() from the elements. 627 | /// API Reference: http://api.jquery.com/die 628 | /// 629 | /// 630 | /// A string containing a JavaScript event type, such as click or keydown. 631 | /// 632 | /// 633 | /// The function that is to be no longer executed. 634 | /// 635 | /// 636 | }, 637 | live: function(eventType, handler){ 638 | /// 639 | /// Attach a handler to the event for all elements which match the current selector, now and in the future. 640 | /// Additional Signatures: 641 | /// 1. .live( eventType, eventData, handler ) 642 | /// API Reference: http://api.jquery.com/live 643 | /// 644 | /// 645 | /// A string containing a JavaScript event type, such as "click" or "keydown." As of jQuery 1.4 the string can contain multiple, space-separated event types or custom event names, as well. 646 | /// 647 | /// 648 | /// A function to execute at the time the event is triggered. 649 | /// 650 | /// 651 | }, 652 | triggerHandler: function(eventType, extraParameters){ 653 | /// 654 | /// Execute all handlers attached to an element for an event. 655 | /// API Reference: http://api.jquery.com/triggerHandler 656 | /// 657 | /// 658 | /// A string containing a JavaScript event type, such as click or submit. 659 | /// 660 | /// 661 | /// An array of additional parameters to pass along to the event handler. 662 | /// 663 | /// 664 | }, 665 | trigger: function(eventType, extraParameters){ 666 | /// 667 | /// Execute all handlers and behaviors attached to the matched elements for the given event type. 668 | /// Additional Signatures: 669 | /// 1. .trigger( event ) 670 | /// API Reference: http://api.jquery.com/trigger 671 | /// 672 | /// 673 | /// A string containing a JavaScript event type, such as click or submit. 674 | /// 675 | /// 676 | /// An array of additional parameters to pass along to the event handler. 677 | /// 678 | /// 679 | }, 680 | ajaxComplete: function(handler){ 681 | /// 682 | /// Register a handler to be called when Ajax requests complete. This is an Ajax Event. 683 | /// API Reference: http://api.jquery.com/ajaxComplete 684 | /// 685 | /// 686 | /// The function to be invoked. 687 | /// 688 | /// 689 | }, 690 | one: function(eventType, eventData, handler){ 691 | /// 692 | /// Attach a handler to an event for the elements. The handler is executed at most once per element. 693 | /// API Reference: http://api.jquery.com/one 694 | /// 695 | /// 696 | /// A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names. 697 | /// 698 | /// 699 | /// A map of data that will be passed to the event handler. 700 | /// 701 | /// 702 | /// A function to execute at the time the event is triggered. 703 | /// 704 | /// 705 | }, 706 | serializeArray: function(){ 707 | /// 708 | /// Encode a set of form elements as an array of names and values. 709 | /// API Reference: http://api.jquery.com/serializeArray 710 | /// 711 | /// 712 | }, 713 | serialize: function(){ 714 | /// 715 | /// Encode a set of form elements as a string for submission. 716 | /// API Reference: http://api.jquery.com/serialize 717 | /// 718 | /// 719 | }, 720 | ajaxSuccess: function(handler){ 721 | /// 722 | /// Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event. 723 | /// API Reference: http://api.jquery.com/ajaxSuccess 724 | /// 725 | /// 726 | /// The function to be invoked. 727 | /// 728 | /// 729 | }, 730 | ajaxStop: function(handler){ 731 | /// 732 | /// Register a handler to be called when all Ajax requests have completed. This is an Ajax Event. 733 | /// API Reference: http://api.jquery.com/ajaxStop 734 | /// 735 | /// 736 | /// The function to be invoked. 737 | /// 738 | /// 739 | }, 740 | ajaxStart: function(handler){ 741 | /// 742 | /// Register a handler to be called when the first Ajax request begins. This is an Ajax Event. 743 | /// API Reference: http://api.jquery.com/ajaxStart 744 | /// 745 | /// 746 | /// The function to be invoked. 747 | /// 748 | /// 749 | }, 750 | ajaxSend: function(handler){ 751 | /// 752 | /// Attach a function to be executed before an Ajax request is sent. This is an Ajax Event. 753 | /// API Reference: http://api.jquery.com/ajaxSend 754 | /// 755 | /// 756 | /// The function to be invoked. 757 | /// 758 | /// 759 | }, 760 | ajaxError: function(handler){ 761 | /// 762 | /// Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event. 763 | /// API Reference: http://api.jquery.com/ajaxError 764 | /// 765 | /// 766 | /// The function to be invoked. 767 | /// 768 | /// 769 | }, 770 | unbind: function(eventType, handler){ 771 | /// 772 | /// Remove a previously-attached event handler from the elements. 773 | /// Additional Signatures: 774 | /// 1. .unbind( eventType, false ) 775 | /// 2. .unbind( event ) 776 | /// API Reference: http://api.jquery.com/unbind 777 | /// 778 | /// 779 | /// A string containing a JavaScript event type, such as click or submit. 780 | /// 781 | /// 782 | /// The function that is to be no longer executed. 783 | /// 784 | /// 785 | }, 786 | bind: function(eventType, eventData, handler){ 787 | /// 788 | /// Attach a handler to an event for the elements. 789 | /// Additional Signatures: 790 | /// 1. .bind( eventType, [eventData], false ) 791 | /// 2. .bind( events ) 792 | /// API Reference: http://api.jquery.com/bind 793 | /// 794 | /// 795 | /// A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names. 796 | /// 797 | /// 798 | /// A map of data that will be passed to the event handler. 799 | /// 800 | /// 801 | /// A function to execute each time the event is triggered. 802 | /// 803 | /// 804 | }, 805 | first: function(){ 806 | /// 807 | /// Reduce the set of matched elements to the first in the set. 808 | /// API Reference: http://api.jquery.com/first 809 | /// 810 | /// 811 | }, 812 | last: function(){ 813 | /// 814 | /// Reduce the set of matched elements to the final one in the set. 815 | /// API Reference: http://api.jquery.com/last 816 | /// 817 | /// 818 | }, 819 | slice: function(start, end){ 820 | /// 821 | /// Reduce the set of matched elements to a subset specified by a range of indices. 822 | /// API Reference: http://api.jquery.com/slice 823 | /// 824 | /// 825 | /// An integer indicating the 0-based position at which the elements begin to be selected. If negative, it indicates an offset from the end of the set. 826 | /// 827 | /// 828 | /// An integer indicating the 0-based position at which the elements stop being selected. If negative, it indicates an offset from the end of the set. If omitted, the range continues until the end of the set. 829 | /// 830 | /// 831 | }, 832 | stop: function(clearQueue, jumpToEnd){ 833 | /// 834 | /// Stop the currently-running animation on the matched elements. 835 | /// API Reference: http://api.jquery.com/stop 836 | /// 837 | /// 838 | /// A Boolean indicating whether to remove queued animation as well. Defaults to false. 839 | /// 840 | /// 841 | /// A Boolean indicating whether to complete the current animation immediately. Defaults to false. 842 | /// 843 | /// 844 | }, 845 | end: function(){ 846 | /// 847 | /// End the most recent filtering operation in the current chain and return the set of matched elements to its previous state. 848 | /// API Reference: http://api.jquery.com/end 849 | /// 850 | /// 851 | }, 852 | andSelf: function(){ 853 | /// 854 | /// Add the previous set of elements on the stack to the current set. 855 | /// API Reference: http://api.jquery.com/andSelf 856 | /// 857 | /// 858 | }, 859 | siblings: function(selector){ 860 | /// 861 | /// Get the siblings of each element in the set of matched elements, optionally filtered by a selector. 862 | /// API Reference: http://api.jquery.com/siblings 863 | /// 864 | /// 865 | /// A string containing a selector expression to match elements against. 866 | /// 867 | /// 868 | }, 869 | animate: function(properties, duration, easing, callback){ 870 | /// 871 | /// Perform a custom animation of a set of CSS properties. 872 | /// Additional Signatures: 873 | /// 1. .animate( properties, options ) 874 | /// API Reference: http://api.jquery.com/animate 875 | /// 876 | /// 877 | /// A map of CSS properties that the animation will move toward. 878 | /// 879 | /// 880 | /// A string or number determining how long the animation will run. 881 | /// 882 | /// 883 | /// A string indicating which easing function to use for the transition. 884 | /// 885 | /// 886 | /// A function to call once the animation is complete. 887 | /// 888 | /// 889 | }, 890 | prevAll: function(selector){ 891 | /// 892 | /// Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector. 893 | /// API Reference: http://api.jquery.com/prevAll 894 | /// 895 | /// 896 | /// A string containing a selector expression to match elements against. 897 | /// 898 | /// 899 | }, 900 | prev: function(selector){ 901 | /// 902 | /// Get the immediately preceding sibling of each element in the set of matched elements, optionally filtered by a selector. 903 | /// API Reference: http://api.jquery.com/prev 904 | /// 905 | /// 906 | /// A string containing a selector expression to match elements against. 907 | /// 908 | /// 909 | }, 910 | fadeTo: function(duration, opacity, callback){ 911 | /// 912 | /// Adjust the opacity of the matched elements. 913 | /// Additional Signatures: 914 | /// 1. .fadeTo( [duration], opacity, [easing], [callback] ) 915 | /// API Reference: http://api.jquery.com/fadeTo 916 | /// 917 | /// 918 | /// A string or number determining how long the animation will run. 919 | /// 920 | /// 921 | /// A number between 0 and 1 denoting the target opacity. 922 | /// 923 | /// 924 | /// A function to call once the animation is complete. 925 | /// 926 | /// 927 | }, 928 | fadeOut: function(duration, callback){ 929 | /// 930 | /// Hide the matched elements by fading them to transparent. 931 | /// Additional Signatures: 932 | /// 1. .fadeOut( [duration], [easing], [callback] ) 933 | /// API Reference: http://api.jquery.com/fadeOut 934 | /// 935 | /// 936 | /// A string or number determining how long the animation will run. 937 | /// 938 | /// 939 | /// A function to call once the animation is complete. 940 | /// 941 | /// 942 | }, 943 | parents: function(selector){ 944 | /// 945 | /// Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector. 946 | /// API Reference: http://api.jquery.com/parents 947 | /// 948 | /// 949 | /// A string containing a selector expression to match elements against. 950 | /// 951 | /// 952 | }, 953 | fadeIn: function(duration, callback){ 954 | /// 955 | /// Display the matched elements by fading them to opaque. 956 | /// Additional Signatures: 957 | /// 1. .fadeIn( [duration], [easing], [callback] ) 958 | /// API Reference: http://api.jquery.com/fadeIn 959 | /// 960 | /// 961 | /// A string or number determining how long the animation will run. 962 | /// 963 | /// 964 | /// A function to call once the animation is complete. 965 | /// 966 | /// 967 | }, 968 | parent: function(selector){ 969 | /// 970 | /// Get the parent of each element in the current set of matched elements, optionally filtered by a selector. 971 | /// API Reference: http://api.jquery.com/parent 972 | /// 973 | /// 974 | /// A string containing a selector expression to match elements against. 975 | /// 976 | /// 977 | }, 978 | offsetParent: function(){ 979 | /// 980 | /// Get the closest ancestor element that is positioned. 981 | /// API Reference: http://api.jquery.com/offsetParent 982 | /// 983 | /// 984 | }, 985 | slideToggle: function(duration, callback){ 986 | /// 987 | /// Display or hide the matched elements with a sliding motion. 988 | /// Additional Signatures: 989 | /// 1. .slideToggle( [duration], [easing], [callback] ) 990 | /// API Reference: http://api.jquery.com/slideToggle 991 | /// 992 | /// 993 | /// A string or number determining how long the animation will run. 994 | /// 995 | /// 996 | /// A function to call once the animation is complete. 997 | /// 998 | /// 999 | }, 1000 | slideUp: function(duration, callback){ 1001 | /// 1002 | /// Hide the matched elements with a sliding motion. 1003 | /// Additional Signatures: 1004 | /// 1. .slideUp( [duration], [easing], [callback] ) 1005 | /// API Reference: http://api.jquery.com/slideUp 1006 | /// 1007 | /// 1008 | /// A string or number determining how long the animation will run. 1009 | /// 1010 | /// 1011 | /// A function to call once the animation is complete. 1012 | /// 1013 | /// 1014 | }, 1015 | nextAll: function(selector){ 1016 | /// 1017 | /// Get all following siblings of each element in the set of matched elements, optionally filtered by a selector. 1018 | /// API Reference: http://api.jquery.com/nextAll 1019 | /// 1020 | /// 1021 | /// A string containing a selector expression to match elements against. 1022 | /// 1023 | /// 1024 | }, 1025 | next: function(selector){ 1026 | /// 1027 | /// Get the immediately following sibling of each element in the set of matched elements. If a selector is provided, it retrieves the next sibling only if it matches that selector. 1028 | /// API Reference: http://api.jquery.com/next 1029 | /// 1030 | /// 1031 | /// A string containing a selector expression to match elements against. 1032 | /// 1033 | /// 1034 | }, 1035 | slideDown: function(duration, callback){ 1036 | /// 1037 | /// Display the matched elements with a sliding motion. 1038 | /// Additional Signatures: 1039 | /// 1. .slideDown( [duration], [easing], [callback] ) 1040 | /// API Reference: http://api.jquery.com/slideDown 1041 | /// 1042 | /// 1043 | /// A string or number determining how long the animation will run. 1044 | /// 1045 | /// 1046 | /// A function to call once the animation is complete. 1047 | /// 1048 | /// 1049 | }, 1050 | find: function(selector){ 1051 | /// 1052 | /// Get the descendants of each element in the current set of matched elements, filtered by a selector. 1053 | /// API Reference: http://api.jquery.com/find 1054 | /// 1055 | /// 1056 | /// A string containing a selector expression to match elements against. 1057 | /// 1058 | /// 1059 | }, 1060 | contents: function(){ 1061 | /// 1062 | /// Get the children of each element in the set of matched elements, including text and comment nodes. 1063 | /// API Reference: http://api.jquery.com/contents 1064 | /// 1065 | /// 1066 | }, 1067 | closest: function(selector){ 1068 | /// 1069 | /// Get the first ancestor element that matches the selector, beginning at the current element and progressing up through the DOM tree. 1070 | /// Additional Signatures: 1071 | /// 1. .closest( selector, [context] ) 1072 | /// API Reference: http://api.jquery.com/closest 1073 | /// 1074 | /// 1075 | /// A string containing a selector expression to match elements against. 1076 | /// 1077 | /// 1078 | }, 1079 | closest: function(selectors, context){ 1080 | /// 1081 | /// Gets an array of all the elements and selectors matched against the current element up through the DOM tree. 1082 | /// API Reference: http://api.jquery.com/closest 1083 | /// 1084 | /// 1085 | /// An array or string containing a selector expression to match elements against (can also be a jQuery object). 1086 | /// 1087 | /// 1088 | /// A DOM element within which a matching element may be found. If no context is passed in then the context of the jQuery set will be used instead. 1089 | /// 1090 | /// 1091 | }, 1092 | load: function(url, data, method){ 1093 | /// 1094 | /// Load data from the server and place the returned HTML into the matched element. 1095 | /// API Reference: http://api.jquery.com/load 1096 | /// 1097 | /// 1098 | /// A string containing the URL to which the request is sent. 1099 | /// 1100 | /// 1101 | /// A map or string that is sent to the server with the request. 1102 | /// 1103 | /// 1104 | /// A callback function that is executed when the request completes. 1105 | /// 1106 | /// 1107 | }, 1108 | children: function(selector){ 1109 | /// 1110 | /// Get the children of each element in the set of matched elements, optionally filtered by a selector. 1111 | /// API Reference: http://api.jquery.com/children 1112 | /// 1113 | /// 1114 | /// A string containing a selector expression to match elements against. 1115 | /// 1116 | /// 1117 | }, 1118 | add: function(selector){ 1119 | /// 1120 | /// Add elements to the set of matched elements. 1121 | /// Additional Signatures: 1122 | /// 1. .add( elements ) 1123 | /// 2. .add( html ) 1124 | /// 3. .add( selector, context ) 1125 | /// API Reference: http://api.jquery.com/add 1126 | /// 1127 | /// 1128 | /// A string containing a selector expression to match additional elements against. 1129 | /// 1130 | /// 1131 | }, 1132 | not: function(selector){ 1133 | /// 1134 | /// Remove elements from the set of matched elements. 1135 | /// Additional Signatures: 1136 | /// 1. .not( elements ) 1137 | /// 2. .not( method ) 1138 | /// API Reference: http://api.jquery.com/not 1139 | /// 1140 | /// 1141 | /// A string containing a selector expression to match elements against. 1142 | /// 1143 | /// 1144 | }, 1145 | outerWidth: function(includeMargin){ 1146 | /// 1147 | /// Get the current computed width for the first element in the set of matched elements, including padding and border. 1148 | /// API Reference: http://api.jquery.com/outerWidth 1149 | /// 1150 | /// 1151 | /// A Boolean indicating whether to include the element's margin in the calculation. 1152 | /// 1153 | /// 1154 | }, 1155 | outerHeight: function(includeMargin){ 1156 | /// 1157 | /// Get the current computed height for the first element in the set of matched elements, including padding, border, and optionally margin. 1158 | /// API Reference: http://api.jquery.com/outerHeight 1159 | /// 1160 | /// 1161 | /// A Boolean indicating whether to include the element's margin in the calculation. 1162 | /// 1163 | /// 1164 | }, 1165 | toggle: function(duration, callback){ 1166 | /// 1167 | /// Display or hide the matched elements. 1168 | /// Additional Signatures: 1169 | /// 1. .toggle( [duration], [easing], [callback] ) 1170 | /// 2. .toggle( showOrHide ) 1171 | /// API Reference: http://api.jquery.com/toggle 1172 | /// 1173 | /// 1174 | /// A string or number determining how long the animation will run. 1175 | /// 1176 | /// 1177 | /// A function to call once the animation is complete. 1178 | /// 1179 | /// 1180 | }, 1181 | innerWidth: function(){ 1182 | /// 1183 | /// Get the current computed width for the first element in the set of matched elements, including padding but not border. 1184 | /// API Reference: http://api.jquery.com/innerWidth 1185 | /// 1186 | /// 1187 | }, 1188 | innerHeight: function(){ 1189 | /// 1190 | /// Get the current computed height for the first element in the set of matched elements, including padding but not border. 1191 | /// API Reference: http://api.jquery.com/innerHeight 1192 | /// 1193 | /// 1194 | }, 1195 | hide: function(){ 1196 | /// 1197 | /// Hide the matched elements. 1198 | /// Additional Signatures: 1199 | /// 1. .hide( duration, [callback] ) 1200 | /// 2. .hide( [duration], [easing], [callback] ) 1201 | /// API Reference: http://api.jquery.com/hide 1202 | /// 1203 | /// 1204 | }, 1205 | width: function(){ 1206 | /// 1207 | /// Get the current computed width for the first element in the set of matched elements. 1208 | /// API Reference: http://api.jquery.com/width 1209 | /// 1210 | /// 1211 | }, 1212 | width: function(value){ 1213 | /// 1214 | /// Set the CSS width of each element in the set of matched elements. 1215 | /// Additional Signatures: 1216 | /// 1. .width( method ) 1217 | /// API Reference: http://api.jquery.com/width 1218 | /// 1219 | /// 1220 | /// An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string). 1221 | /// 1222 | /// 1223 | }, 1224 | height: function(){ 1225 | /// 1226 | /// Get the current computed height for the first element in the set of matched elements. 1227 | /// API Reference: http://api.jquery.com/height 1228 | /// 1229 | /// 1230 | }, 1231 | height: function(value){ 1232 | /// 1233 | /// Set the CSS height of every matched element. 1234 | /// Additional Signatures: 1235 | /// 1. .height( method ) 1236 | /// API Reference: http://api.jquery.com/height 1237 | /// 1238 | /// 1239 | /// An integer representing the number of pixels, or an integer with an optional unit of measure appended (as a string). 1240 | /// 1241 | /// 1242 | }, 1243 | show: function(){ 1244 | /// 1245 | /// Display the matched elements. 1246 | /// Additional Signatures: 1247 | /// 1. .show( duration, [callback] ) 1248 | /// 2. .show( [duration], [easing], [callback] ) 1249 | /// API Reference: http://api.jquery.com/show 1250 | /// 1251 | /// 1252 | }, 1253 | scrollLeft: function(){ 1254 | /// 1255 | /// Get the current horizontal position of the scroll bar for the first element in the set of matched elements. 1256 | /// API Reference: http://api.jquery.com/scrollLeft 1257 | /// 1258 | /// 1259 | }, 1260 | scrollLeft: function(value){ 1261 | /// 1262 | /// Set the current horizontal position of the scroll bar for each of the set of matched elements. 1263 | /// API Reference: http://api.jquery.com/scrollLeft 1264 | /// 1265 | /// 1266 | /// An integer indicating the new position to set the scroll bar to. 1267 | /// 1268 | /// 1269 | }, 1270 | scrollTop: function(){ 1271 | /// 1272 | /// Get the current vertical position of the scroll bar for the first element in the set of matched elements. 1273 | /// API Reference: http://api.jquery.com/scrollTop 1274 | /// 1275 | /// 1276 | }, 1277 | scrollTop: function(value){ 1278 | /// 1279 | /// Set the current vertical position of the scroll bar for each of the set of matched elements. 1280 | /// API Reference: http://api.jquery.com/scrollTop 1281 | /// 1282 | /// 1283 | /// An integer indicating the new position to set the scroll bar to. 1284 | /// 1285 | /// 1286 | }, 1287 | position: function(){ 1288 | /// 1289 | /// Get the current coordinates of the first element in the set of matched elements, relative to the offset parent. 1290 | /// API Reference: http://api.jquery.com/position 1291 | /// 1292 | /// 1293 | }, 1294 | offset: function(){ 1295 | /// 1296 | /// Get the current coordinates of the first element in the set of matched elements, relative to the document. 1297 | /// API Reference: http://api.jquery.com/offset 1298 | /// 1299 | /// 1300 | }, 1301 | offset: function(coordinates){ 1302 | /// 1303 | /// Set the current coordinates of every element in the set of matched elements, relative to the document. 1304 | /// Additional Signatures: 1305 | /// 1. .offset( method ) 1306 | /// API Reference: http://api.jquery.com/offset 1307 | /// 1308 | /// 1309 | /// An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements. 1310 | /// 1311 | /// 1312 | }, 1313 | css: function(propertyName){ 1314 | /// 1315 | /// Get the value of a style property for the first element in the set of matched elements. 1316 | /// API Reference: http://api.jquery.com/css 1317 | /// 1318 | /// 1319 | /// A CSS property. 1320 | /// 1321 | /// 1322 | }, 1323 | css: function(propertyName, value){ 1324 | /// 1325 | /// Set one or more CSS properties for the set of matched elements. 1326 | /// Additional Signatures: 1327 | /// 1. .css( propertyName, method ) 1328 | /// 2. .css( map ) 1329 | /// API Reference: http://api.jquery.com/css 1330 | /// 1331 | /// 1332 | /// A CSS property name. 1333 | /// 1334 | /// 1335 | /// A value to set for the property. 1336 | /// 1337 | /// 1338 | }, 1339 | unwrap: function(){ 1340 | /// 1341 | /// Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place. 1342 | /// API Reference: http://api.jquery.com/unwrap 1343 | /// 1344 | /// 1345 | }, 1346 | detach: function(selector){ 1347 | /// 1348 | /// Remove the set of matched elements from the DOM. 1349 | /// API Reference: http://api.jquery.com/detach 1350 | /// 1351 | /// 1352 | /// A selector expression that filters the set of matched elements to be removed. 1353 | /// 1354 | /// 1355 | }, 1356 | clone: function(withDataAndEvents){ 1357 | /// 1358 | /// Create a deep copy of the set of matched elements. 1359 | /// API Reference: http://api.jquery.com/clone 1360 | /// 1361 | /// 1362 | /// A Boolean indicating whether event handlers should be copied along with the elements. As of jQuery 1.4 element data will be copied as well. 1363 | /// 1364 | /// 1365 | }, 1366 | remove: function(selector){ 1367 | /// 1368 | /// Remove the set of matched elements from the DOM. 1369 | /// API Reference: http://api.jquery.com/remove 1370 | /// 1371 | /// 1372 | /// A selector expression that filters the set of matched elements to be removed. 1373 | /// 1374 | /// 1375 | }, 1376 | empty: function(){ 1377 | /// 1378 | /// Remove all child nodes of the set of matched elements from the DOM. 1379 | /// API Reference: http://api.jquery.com/empty 1380 | /// 1381 | /// 1382 | }, 1383 | replaceAll: function(){ 1384 | /// 1385 | /// Replace each target element with the set of matched elements. 1386 | /// API Reference: http://api.jquery.com/replaceAll 1387 | /// 1388 | /// 1389 | }, 1390 | replaceWith: function(newContent){ 1391 | /// 1392 | /// Replace each element in the set of matched elements with the provided new content. 1393 | /// Additional Signatures: 1394 | /// 1. .replaceWith( method ) 1395 | /// API Reference: http://api.jquery.com/replaceWith 1396 | /// 1397 | /// 1398 | /// The content to insert. May be an HTML string, DOM element, or jQuery object. 1399 | /// 1400 | /// 1401 | }, 1402 | wrapInner: function(wrappingElement){ 1403 | /// 1404 | /// Wrap an HTML structure around the content of each element in the set of matched elements. 1405 | /// Additional Signatures: 1406 | /// 1. .wrapInner( wrappingFunction ) 1407 | /// API Reference: http://api.jquery.com/wrapInner 1408 | /// 1409 | /// 1410 | /// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the content of the matched elements. 1411 | /// 1412 | /// 1413 | }, 1414 | wrapAll: function(wrappingElement){ 1415 | /// 1416 | /// Wrap an HTML structure around all elements in the set of matched elements. 1417 | /// API Reference: http://api.jquery.com/wrapAll 1418 | /// 1419 | /// 1420 | /// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the matched elements. 1421 | /// 1422 | /// 1423 | }, 1424 | wrap: function(wrappingElement){ 1425 | /// 1426 | /// Wrap an HTML structure around each element in the set of matched elements. 1427 | /// Additional Signatures: 1428 | /// 1. .wrap( wrappingFunction ) 1429 | /// API Reference: http://api.jquery.com/wrap 1430 | /// 1431 | /// 1432 | /// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the matched elements. 1433 | /// 1434 | /// 1435 | }, 1436 | insertBefore: function(target){ 1437 | /// 1438 | /// Insert every element in the set of matched elements before the target. 1439 | /// API Reference: http://api.jquery.com/insertBefore 1440 | /// 1441 | /// 1442 | /// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted before the element(s) specified by this parameter. 1443 | /// 1444 | /// 1445 | }, 1446 | before: function(content){ 1447 | /// 1448 | /// Insert content, specified by the parameter, before each element in the set of matched elements. 1449 | /// Additional Signatures: 1450 | /// 1. .before( method ) 1451 | /// API Reference: http://api.jquery.com/before 1452 | /// 1453 | /// 1454 | /// An element, HTML string, or jQuery object to insert before each element in the set of matched elements. 1455 | /// 1456 | /// 1457 | }, 1458 | insertAfter: function(target){ 1459 | /// 1460 | /// Insert every element in the set of matched elements after the target. 1461 | /// API Reference: http://api.jquery.com/insertAfter 1462 | /// 1463 | /// 1464 | /// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted after the element(s) specified by this parameter. 1465 | /// 1466 | /// 1467 | }, 1468 | after: function(content){ 1469 | /// 1470 | /// Insert content, specified by the parameter, after each element in the set of matched elements. 1471 | /// Additional Signatures: 1472 | /// 1. .after( method ) 1473 | /// API Reference: http://api.jquery.com/after 1474 | /// 1475 | /// 1476 | /// An element, HTML string, or jQuery object to insert after each element in the set of matched elements. 1477 | /// 1478 | /// 1479 | }, 1480 | prependTo: function(target){ 1481 | /// 1482 | /// Insert every element in the set of matched elements to the beginning of the target. 1483 | /// API Reference: http://api.jquery.com/prependTo 1484 | /// 1485 | /// 1486 | /// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted at the beginning of the element(s) specified by this parameter. 1487 | /// 1488 | /// 1489 | }, 1490 | prepend: function(content){ 1491 | /// 1492 | /// Insert content, specified by the parameter, to the beginning of each element in the set of matched elements. 1493 | /// Additional Signatures: 1494 | /// 1. .prepend( method ) 1495 | /// API Reference: http://api.jquery.com/prepend 1496 | /// 1497 | /// 1498 | /// An element, HTML string, or jQuery object to insert at the beginning of each element in the set of matched elements. 1499 | /// 1500 | /// 1501 | }, 1502 | appendTo: function(target){ 1503 | /// 1504 | /// Insert every element in the set of matched elements to the end of the target. 1505 | /// API Reference: http://api.jquery.com/appendTo 1506 | /// 1507 | /// 1508 | /// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted at the end of the element(s) specified by this parameter. 1509 | /// 1510 | /// 1511 | }, 1512 | append: function(content){ 1513 | /// 1514 | /// Insert content, specified by the parameter, to the end of each element in the set of matched elements. 1515 | /// Additional Signatures: 1516 | /// 1. .append( method ) 1517 | /// API Reference: http://api.jquery.com/append 1518 | /// 1519 | /// 1520 | /// An element, HTML string, or jQuery object to insert at the end of each element in the set of matched elements. 1521 | /// 1522 | /// 1523 | }, 1524 | val: function(){ 1525 | /// 1526 | /// Get the current value of the first element in the set of matched elements. 1527 | /// API Reference: http://api.jquery.com/val 1528 | /// 1529 | /// 1530 | }, 1531 | val: function(value){ 1532 | /// 1533 | /// Set the value of each element in the set of matched elements. 1534 | /// Additional Signatures: 1535 | /// 1. .val( method ) 1536 | /// API Reference: http://api.jquery.com/val 1537 | /// 1538 | /// 1539 | /// A string of text or an array of strings to set as the value property of each matched element. 1540 | /// 1541 | /// 1542 | }, 1543 | text: function(){ 1544 | /// 1545 | /// Get the combined text contents of each element in the set of matched elements, including their descendants. 1546 | /// API Reference: http://api.jquery.com/text 1547 | /// 1548 | /// 1549 | }, 1550 | text: function(textString){ 1551 | /// 1552 | /// Set the content of each element in the set of matched elements to the specified text. 1553 | /// Additional Signatures: 1554 | /// 1. .text( method ) 1555 | /// API Reference: http://api.jquery.com/text 1556 | /// 1557 | /// 1558 | /// A string of text to set as the content of each matched element. 1559 | /// 1560 | /// 1561 | }, 1562 | html: function(){ 1563 | /// 1564 | /// Get the HTML contents of the first element in the set of matched elements. 1565 | /// API Reference: http://api.jquery.com/html 1566 | /// 1567 | /// 1568 | }, 1569 | html: function(htmlString){ 1570 | /// 1571 | /// Set the HTML contents of each element in the set of matched elements. 1572 | /// Additional Signatures: 1573 | /// 1. .html( method ) 1574 | /// API Reference: http://api.jquery.com/html 1575 | /// 1576 | /// 1577 | /// A string of HTML to set as the content of each matched element. 1578 | /// 1579 | /// 1580 | }, 1581 | map: function(method){ 1582 | /// 1583 | /// Pass each element in the current matched set through a function, producing a new jQuery object containing the return values. 1584 | /// API Reference: http://api.jquery.com/map 1585 | /// 1586 | /// 1587 | /// A function object that will be invoked for each element in the current set. 1588 | /// 1589 | /// 1590 | }, 1591 | is: function(selector){ 1592 | /// 1593 | /// Check the current matched set of elements against a selector and return true if at least one of these elements matches the selector. 1594 | /// API Reference: http://api.jquery.com/is 1595 | /// 1596 | /// 1597 | /// A string containing a selector expression to match elements against. 1598 | /// 1599 | /// 1600 | }, 1601 | eq: function(index){ 1602 | /// 1603 | /// Reduce the set of matched elements to the one at the specified index. 1604 | /// Additional Signatures: 1605 | /// 1. .eq( -index ) 1606 | /// API Reference: http://api.jquery.com/eq 1607 | /// 1608 | /// 1609 | /// An integer indicating the 0-based position of the element. 1610 | /// 1611 | /// 1612 | }, 1613 | filter: function(selector){ 1614 | /// 1615 | /// Reduce the set of matched elements to those that match the selector or pass the function's test. 1616 | /// Additional Signatures: 1617 | /// 1. .filter( method ) 1618 | /// 2. .filter( element ) 1619 | /// 3. .filter( jQuery object ) 1620 | /// API Reference: http://api.jquery.com/filter 1621 | /// 1622 | /// 1623 | /// A string containing a selector expression to match the current set of elements against. 1624 | /// 1625 | /// 1626 | }, 1627 | toggleClass: function(className){ 1628 | /// 1629 | /// Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the switch argument. 1630 | /// Additional Signatures: 1631 | /// 1. .toggleClass( className, switch ) 1632 | /// 2. .toggleClass( method, [switch] ) 1633 | /// API Reference: http://api.jquery.com/toggleClass 1634 | /// 1635 | /// 1636 | /// One or more class names (separated by spaces) to be toggled for each element in the matched set. 1637 | /// 1638 | /// 1639 | }, 1640 | removeClass: function(className){ 1641 | /// 1642 | /// Remove a single class, multiple classes, or all classes from each element in the set of matched elements. 1643 | /// Additional Signatures: 1644 | /// 1. .removeClass( method ) 1645 | /// API Reference: http://api.jquery.com/removeClass 1646 | /// 1647 | /// 1648 | /// A class name to be removed from the class attribute of each matched element. 1649 | /// 1650 | /// 1651 | }, 1652 | hasClass: function(className){ 1653 | /// 1654 | /// Determine whether any of the matched elements are assigned the given class. 1655 | /// API Reference: http://api.jquery.com/hasClass 1656 | /// 1657 | /// 1658 | /// The class name to search for. 1659 | /// 1660 | /// 1661 | }, 1662 | removeAttr: function(attributeName){ 1663 | /// 1664 | /// Remove an attribute from each element in the set of matched elements. 1665 | /// API Reference: http://api.jquery.com/removeAttr 1666 | /// 1667 | /// 1668 | /// An attribute to remove. 1669 | /// 1670 | /// 1671 | }, 1672 | attr: function(attributeName){ 1673 | /// 1674 | /// Get the value of an attribute for the first element in the set of matched elements. 1675 | /// API Reference: http://api.jquery.com/attr 1676 | /// 1677 | /// 1678 | /// The name of the attribute to get. 1679 | /// 1680 | /// 1681 | }, 1682 | attr: function(attributeName, value){ 1683 | /// 1684 | /// Set one or more attributes for the set of matched elements. 1685 | /// Additional Signatures: 1686 | /// 1. .attr( map ) 1687 | /// 2. .attr( attributeName, method ) 1688 | /// API Reference: http://api.jquery.com/attr 1689 | /// 1690 | /// 1691 | /// The name of the attribute to set. 1692 | /// 1693 | /// 1694 | /// A value to set for the attribute. 1695 | /// 1696 | /// 1697 | }, 1698 | addClass: function(className){ 1699 | /// 1700 | /// Adds the specified class(es) to each of the set of matched elements. 1701 | /// Additional Signatures: 1702 | /// 1. .addClass( method ) 1703 | /// API Reference: http://api.jquery.com/addClass 1704 | /// 1705 | /// 1706 | /// One or more class names to be added to the class attribute of each matched element. 1707 | /// 1708 | /// 1709 | } 1710 | }; 1711 | 1712 | jQuery.type = function(obj){ 1713 | /// 1714 | /// Determine the internal JavaScript [[Class]] of an object. 1715 | /// API Reference: http://api.jquery.com/jQuery.type 1716 | /// 1717 | /// 1718 | /// Object to get the internal JavaScript [[Class]] of. 1719 | /// 1720 | /// 1721 | }; 1722 | jQuery.isWindow = function(obj){ 1723 | /// 1724 | /// Determine whether the argument is a window. 1725 | /// API Reference: http://api.jquery.com/jQuery.isWindow 1726 | /// 1727 | /// 1728 | /// Object to test whether or not it is a window. 1729 | /// 1730 | /// 1731 | }; 1732 | jQuery.error = function(message){ 1733 | /// 1734 | /// Takes a string and throws an exception containing it. 1735 | /// API Reference: http://api.jquery.com/jQuery.error 1736 | /// 1737 | /// 1738 | /// The message to send out. 1739 | /// 1740 | }; 1741 | jQuery.parseJSON = function(json){ 1742 | /// 1743 | /// Takes a well-formed JSON string and returns the resulting JavaScript object. 1744 | /// API Reference: http://api.jquery.com/jQuery.parseJSON 1745 | /// 1746 | /// 1747 | /// The JSON string to parse. 1748 | /// 1749 | /// 1750 | }; 1751 | jQuery.proxy = function(method, context){ 1752 | /// 1753 | /// Takes a function and returns a new one that will always have a particular context. 1754 | /// Additional Signatures: 1755 | /// 1. jQuery.proxy( context, name ) 1756 | /// API Reference: http://api.jquery.com/jQuery.proxy 1757 | /// 1758 | /// 1759 | /// The function whose context will be changed. 1760 | /// 1761 | /// 1762 | /// The object to which the context (`this`) of the function should be set. 1763 | /// 1764 | /// 1765 | }; 1766 | jQuery.contains = function(container, contained){ 1767 | /// 1768 | /// Check to see if a DOM node is within another DOM node. 1769 | /// API Reference: http://api.jquery.com/jQuery.contains 1770 | /// 1771 | /// 1772 | /// The DOM element that may contain the other element. 1773 | /// 1774 | /// 1775 | /// The DOM node that may be contained by the other element. 1776 | /// 1777 | /// 1778 | }; 1779 | jQuery.noop = function(){ 1780 | /// 1781 | /// An empty function. 1782 | /// API Reference: http://api.jquery.com/jQuery.noop 1783 | /// 1784 | /// 1785 | }; 1786 | jQuery.globalEval = function(code){ 1787 | /// 1788 | /// Execute some JavaScript code globally. 1789 | /// API Reference: http://api.jquery.com/jQuery.globalEval 1790 | /// 1791 | /// 1792 | /// The JavaScript code to execute. 1793 | /// 1794 | }; 1795 | jQuery.isXMLDoc = function(node){ 1796 | /// 1797 | /// Check to see if a DOM node is within an XML document (or is an XML document). 1798 | /// API Reference: http://api.jquery.com/jQuery.isXMLDoc 1799 | /// 1800 | /// 1801 | /// The DOM node that will be checked to see if it's in an XML document. 1802 | /// 1803 | /// 1804 | }; 1805 | jQuery.removeData = function(element, name){ 1806 | /// 1807 | /// Remove a previously-stored piece of data. 1808 | /// API Reference: http://api.jquery.com/jQuery.removeData 1809 | /// 1810 | /// 1811 | /// A DOM element from which to remove data. 1812 | /// 1813 | /// 1814 | /// A string naming the piece of data to remove. 1815 | /// 1816 | /// 1817 | }; 1818 | jQuery.data = function(element, key, value){ 1819 | /// 1820 | /// Store arbitrary data associated with the specified element. 1821 | /// API Reference: http://api.jquery.com/jQuery.data 1822 | /// 1823 | /// 1824 | /// The DOM element to associate with the data. 1825 | /// 1826 | /// 1827 | /// A string naming the piece of data to set. 1828 | /// 1829 | /// 1830 | /// The new data value. 1831 | /// 1832 | /// 1833 | }; 1834 | jQuery.data = function(element, key){ 1835 | /// 1836 | /// Returns value at named data store for the element, as set by jQuery.data(element, name, value), or the full data store for the element. 1837 | /// Additional Signatures: 1838 | /// 1. jQuery.data( element ) 1839 | /// API Reference: http://api.jquery.com/jQuery.data 1840 | /// 1841 | /// 1842 | /// The DOM element to query for the data. 1843 | /// 1844 | /// 1845 | /// Name of the data stored. 1846 | /// 1847 | /// 1848 | }; 1849 | jQuery.dequeue = function(element, queueName){ 1850 | /// 1851 | /// Execute the next function on the queue for the matched element. 1852 | /// API Reference: http://api.jquery.com/jQuery.dequeue 1853 | /// 1854 | /// 1855 | /// A DOM element from which to remove and execute a queued function. 1856 | /// 1857 | /// 1858 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 1859 | /// 1860 | /// 1861 | }; 1862 | jQuery.queue = function(element, queueName){ 1863 | /// 1864 | /// Show the queue of functions to be executed on the matched element. 1865 | /// API Reference: http://api.jquery.com/jQuery.queue 1866 | /// 1867 | /// 1868 | /// A DOM element to inspect for an attached queue. 1869 | /// 1870 | /// 1871 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 1872 | /// 1873 | /// 1874 | }; 1875 | jQuery.queue = function(element, queueName, newQueue){ 1876 | /// 1877 | /// Manipulate the queue of functions to be executed on the matched element. 1878 | /// Additional Signatures: 1879 | /// 1. jQuery.queue( element, queueName, method ) 1880 | /// API Reference: http://api.jquery.com/jQuery.queue 1881 | /// 1882 | /// 1883 | /// A DOM element where the array of queued functions is attached. 1884 | /// 1885 | /// 1886 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 1887 | /// 1888 | /// 1889 | /// An array of functions to replace the current queue contents. 1890 | /// 1891 | /// 1892 | }; 1893 | jQuery.isEmptyObject = function(object){ 1894 | /// 1895 | /// Check to see if an object is empty (contains no properties). 1896 | /// API Reference: http://api.jquery.com/jQuery.isEmptyObject 1897 | /// 1898 | /// 1899 | /// The object that will be checked to see if it's empty. 1900 | /// 1901 | /// 1902 | }; 1903 | jQuery.isPlainObject = function(object){ 1904 | /// 1905 | /// Check to see if an object is a plain object (created using "{}" or "new Object"). 1906 | /// API Reference: http://api.jquery.com/jQuery.isPlainObject 1907 | /// 1908 | /// 1909 | /// The object that will be checked to see if it's a plain object. 1910 | /// 1911 | /// 1912 | }; 1913 | jQuery.noConflict = function(removeAll){ 1914 | /// 1915 | /// Relinquish jQuery's control of the $ variable. 1916 | /// API Reference: http://api.jquery.com/jQuery.noConflict 1917 | /// 1918 | /// 1919 | /// A Boolean indicating whether to remove all jQuery variables from the global scope (including jQuery itself). 1920 | /// 1921 | /// 1922 | }; 1923 | jQuery.ajaxSetup = function(options){ 1924 | /// 1925 | /// Set default values for future Ajax requests. 1926 | /// API Reference: http://api.jquery.com/jQuery.ajaxSetup 1927 | /// 1928 | /// 1929 | /// A set of key/value pairs that configure the default Ajax request. All options are optional. 1930 | /// 1931 | }; 1932 | jQuery.post = function(url, data, method, dataType){ 1933 | /// 1934 | /// Load data from the server using a HTTP POST request. 1935 | /// API Reference: http://api.jquery.com/jQuery.post 1936 | /// 1937 | /// 1938 | /// A string containing the URL to which the request is sent. 1939 | /// 1940 | /// 1941 | /// A map or string that is sent to the server with the request. 1942 | /// 1943 | /// 1944 | /// A callback function that is executed if the request succeeds. 1945 | /// 1946 | /// 1947 | /// The type of data expected from the server. 1948 | /// 1949 | /// 1950 | }; 1951 | jQuery.getScript = function(url, method){ 1952 | /// 1953 | /// Load a JavaScript file from the server using a GET HTTP request, then execute it. 1954 | /// API Reference: http://api.jquery.com/jQuery.getScript 1955 | /// 1956 | /// 1957 | /// A string containing the URL to which the request is sent. 1958 | /// 1959 | /// 1960 | /// A callback function that is executed if the request succeeds. 1961 | /// 1962 | /// 1963 | }; 1964 | jQuery.getJSON = function(url, data, method){ 1965 | /// 1966 | /// Load JSON-encoded data from the server using a GET HTTP request. 1967 | /// API Reference: http://api.jquery.com/jQuery.getJSON 1968 | /// 1969 | /// 1970 | /// A string containing the URL to which the request is sent. 1971 | /// 1972 | /// 1973 | /// A map or string that is sent to the server with the request. 1974 | /// 1975 | /// 1976 | /// A callback function that is executed if the request succeeds. 1977 | /// 1978 | /// 1979 | }; 1980 | jQuery.get = function(url, data, method, dataType){ 1981 | /// 1982 | /// Load data from the server using a HTTP GET request. 1983 | /// API Reference: http://api.jquery.com/jQuery.get 1984 | /// 1985 | /// 1986 | /// A string containing the URL to which the request is sent. 1987 | /// 1988 | /// 1989 | /// A map or string that is sent to the server with the request. 1990 | /// 1991 | /// 1992 | /// A callback function that is executed if the request succeeds. 1993 | /// 1994 | /// 1995 | /// The type of data expected from the server. 1996 | /// 1997 | /// 1998 | }; 1999 | jQuery.ajax = function(settings){ 2000 | /// 2001 | /// Perform an asynchronous HTTP (Ajax) request. 2002 | /// API Reference: http://api.jquery.com/jQuery.ajax 2003 | /// 2004 | /// 2005 | /// A set of key/value pairs that configure the Ajax request. All options are optional. A default can be set for any option with $.ajaxSetup(). 2006 | /// 2007 | /// 2008 | }; 2009 | jQuery.param = function(obj){ 2010 | /// 2011 | /// Create a serialized representation of an array or object, suitable for use in a URL query string or Ajax request. 2012 | /// Additional Signatures: 2013 | /// 1. jQuery.param( obj, traditional ) 2014 | /// API Reference: http://api.jquery.com/jQuery.param 2015 | /// 2016 | /// 2017 | /// An array or object to serialize. 2018 | /// 2019 | /// 2020 | }; 2021 | jQuery.trim = function(str){ 2022 | /// 2023 | /// Remove the whitespace from the beginning and end of a string. 2024 | /// API Reference: http://api.jquery.com/jQuery.trim 2025 | /// 2026 | /// 2027 | /// The string to trim. 2028 | /// 2029 | /// 2030 | }; 2031 | jQuery.isFunction = function(obj){ 2032 | /// 2033 | /// Determine if the argument passed is a Javascript function object. 2034 | /// API Reference: http://api.jquery.com/jQuery.isFunction 2035 | /// 2036 | /// 2037 | /// Object to test whether or not it is a function. 2038 | /// 2039 | /// 2040 | }; 2041 | jQuery.isArray = function(obj){ 2042 | /// 2043 | /// Determine whether the argument is an array. 2044 | /// API Reference: http://api.jquery.com/jQuery.isArray 2045 | /// 2046 | /// 2047 | /// Object to test whether or not it is an array. 2048 | /// 2049 | /// 2050 | }; 2051 | jQuery.unique = function(array){ 2052 | /// 2053 | /// Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers. 2054 | /// API Reference: http://api.jquery.com/jQuery.unique 2055 | /// 2056 | /// 2057 | /// The Array of DOM elements. 2058 | /// 2059 | /// 2060 | }; 2061 | jQuery.merge = function(first, second){ 2062 | /// 2063 | /// Merge the contents of two arrays together into the first array. 2064 | /// API Reference: http://api.jquery.com/jQuery.merge 2065 | /// 2066 | /// 2067 | /// The first array to merge, the elements of second added. 2068 | /// 2069 | /// 2070 | /// The second array to merge into the first, unaltered. 2071 | /// 2072 | /// 2073 | }; 2074 | jQuery.inArray = function(value, array){ 2075 | /// 2076 | /// Search for a specified value within an array and return its index (or -1 if not found). 2077 | /// API Reference: http://api.jquery.com/jQuery.inArray 2078 | /// 2079 | /// 2080 | /// The value to search for. 2081 | /// 2082 | /// 2083 | /// An array through which to search. 2084 | /// 2085 | /// 2086 | }; 2087 | jQuery.map = function(array, method){ 2088 | /// 2089 | /// Translate all items in an array or array-like object to another array of items. 2090 | /// API Reference: http://api.jquery.com/jQuery.map 2091 | /// 2092 | /// 2093 | /// The Array to translate. 2094 | /// 2095 | /// 2096 | /// The function to process each item against. The first argument to the function is the list item, the second argument is the index in array The function can return any value. this will be the global window object. 2097 | /// 2098 | /// 2099 | }; 2100 | jQuery.makeArray = function(obj){ 2101 | /// 2102 | /// Convert an array-like object into a true JavaScript array. 2103 | /// API Reference: http://api.jquery.com/jQuery.makeArray 2104 | /// 2105 | /// 2106 | /// Any object to turn into a native Array. 2107 | /// 2108 | /// 2109 | }; 2110 | jQuery.grep = function(array, method, invert){ 2111 | /// 2112 | /// Finds the elements of an array which satisfy a filter function. The original array is not affected. 2113 | /// API Reference: http://api.jquery.com/jQuery.grep 2114 | /// 2115 | /// 2116 | /// The array to search through. 2117 | /// 2118 | /// 2119 | /// The function to process each item against. The first argument to the function is the item, and the second argument is the index. The function should return a Boolean value. this will be the global window object. 2120 | /// 2121 | /// 2122 | /// If "invert" is false, or not provided, then the function returns an array consisting of all elements for which "callback" returns true. If "invert" is true, then the function returns an array consisting of all elements for which "callback" returns false. 2123 | /// 2124 | /// 2125 | }; 2126 | jQuery.extend = function(target, object1, objectN){ 2127 | /// 2128 | /// Merge the contents of two or more objects together into the first object. 2129 | /// Additional Signatures: 2130 | /// 1. jQuery.extend( [deep], target, object1, [objectN] ) 2131 | /// API Reference: http://api.jquery.com/jQuery.extend 2132 | /// 2133 | /// 2134 | /// An object that will receive the new properties if additional objects are passed in or that will extend the jQuery namespace if it is the sole argument. 2135 | /// 2136 | /// 2137 | /// An object containing additional properties to merge in. 2138 | /// 2139 | /// 2140 | /// Additional objects containing properties to merge in. 2141 | /// 2142 | /// 2143 | }; 2144 | jQuery.each = function(collection, method){ 2145 | /// 2146 | /// A generic iterator function, which can be used to seamlessly iterate over both objects and arrays. Arrays and array-like objects with a length property (such as a function's arguments object) are iterated by numeric index, from 0 to length-1. Other objects are iterated via their named properties. 2147 | /// API Reference: http://api.jquery.com/jQuery.each 2148 | /// 2149 | /// 2150 | /// The object or array to iterate over. 2151 | /// 2152 | /// 2153 | /// The function that will be executed on every object. 2154 | /// 2155 | /// 2156 | }; -------------------------------------------------------------------------------- /jquery.mobile-vsdoc.js: -------------------------------------------------------------------------------- 1 | jQuery.mobile = function(){ 2 | /// 3 | /// The root jQuery Mobile Object. 4 | /// 5 | }; 6 | 7 | $.extend(jQuery.mobile, { 8 | changePage: function( to, transition, back, changeHash ){ 9 | /// 10 | /// Programmatically change from one page to another. This method is used internally for transitions that occur as a result of clicking a link or submitting a form, when those features are enabled. 11 | /// Additional Signatures: 12 | /// 1. $.mobile.addResolutionBreakpoints( arrayOfNumbers ) - Pass an array of numbers to add min/max classes for multiple widths. 13 | /// 14 | /// 15 | /// 1. String - A url to transition to. 16 | /// 2. jQuery - A jQuery object to transition to. 17 | /// 3. Array - Array specifying two page references [from,to] for transitioning from a known page. From is otherwise assumed to be the current page in view (or $.mobile.activePage ). 18 | /// 4. Object - Object for sending form data. ({to: url, data: serialized form data, type: 'get' or 'post'} 19 | /// 20 | /// 21 | /// Specifies the effect to use when switching between pages. eg. 'pop', 'slide', 'none'. 22 | /// 23 | /// 24 | /// Default value is false. True will cause a reverse-direction transition. 25 | /// 26 | /// 27 | /// Default value is true. Update the hash to the to page's URL when page change is complete. 28 | /// 29 | }, 30 | pageLoading: function( done ){ 31 | /// 32 | /// Show or hide the page loading message, which is configurable via $.mobile.loadingMessage. 33 | /// 34 | /// 35 | /// Defaults value is false, indicating loading has started. A value of true will hide the loading message. 36 | /// 37 | }, 38 | silentScroll: function( yPos ){ 39 | /// 40 | /// Scroll to a particular Y position without triggering scroll event listeners. 41 | /// 42 | /// 43 | /// Specifies a y-axis position that the page should scroll to. 44 | /// 45 | }, 46 | addResolutionBreakpoints: function( width ){ 47 | /// 48 | /// Add width breakpoints to the min/max width classes that are added to the HTML element. 49 | /// Additional Signatures: 50 | /// 1. $.mobile.addResolutionBreakpoints( arrayOfNumbers ) - Pass an array of numbers to add min/max classes for multiple widths. 51 | /// 52 | /// 53 | /// A number or array of numbers to add to the resolution classes. 54 | /// 55 | }, 56 | activePage: function(){ 57 | /// 58 | /// Returns a reference to the page currently in view. 59 | /// 60 | /// 61 | /// Unknown. 62 | /// 63 | /// 64 | }, 65 | media: function( query ){ 66 | /// 67 | /// A function that allows you to test whether a particular CSS Media Query applies. 68 | /// 69 | /// 70 | /// A string specifyin the query or css type to be queried. 71 | /// //test for screen media type 72 | /// $.mobile.media("screen"); 73 | /// //test a min-width media query 74 | /// $.mobile.media("screen and (min-width: 480px)"); 75 | /// //test for iOS retina display 76 | /// $.mobile.media("screen and (-webkit-min-device-pixel-ratio: 2)"); 77 | /// 78 | /// 79 | /// If the browser supports the type or query specified, and it currently applies, the function will return true. If not, it'll return false. 80 | /// 81 | } 82 | }); 83 | 84 | /// 85 | /// 86 | /// 87 | /// 88 | /// 89 | /// 90 | /// 91 | /// 92 | /// -------------------------------------------------------------------------------- /mock site/js/JScript.js: -------------------------------------------------------------------------------- 1 |  -------------------------------------------------------------------------------- /mock site/js/jquery-1.5-vsdoc.js: -------------------------------------------------------------------------------- 1 | var jQuery = $ = function(selector, context){ 2 | /// 3 | /// Accepts a string containing a CSS selector which is then used to match a set of elements. 4 | /// Additional Signatures: 5 | /// 1. jQuery( element ) 6 | /// 2. jQuery( elementArray ) 7 | /// 3. jQuery( jQuery object ) 8 | /// 4. jQuery( ) 9 | /// 5. jQuery( html, [ownerDocument] ) 10 | /// 6. jQuery( html, props ) 11 | /// 7. jQuery( callback ) 12 | /// API Reference: http://api.jquery.com/jQuery 13 | /// 14 | /// 15 | /// A string containing a selector expression 16 | /// 17 | /// 18 | /// A DOM Element, Document, or jQuery to use as context 19 | /// 20 | /// 21 | }; 22 | $.fn = $.prototype = { 23 | 24 | fadeToggle: function(duration, easing, callback){ 25 | /// 26 | /// Display or hide the matched elements by animating their opacity. 27 | /// API Reference: http://api.jquery.com/fadeToggle 28 | /// 29 | /// 30 | /// A string or number determining how long the animation will run. 31 | /// 32 | /// 33 | /// A string indicating which easing function to use for the transition. 34 | /// 35 | /// 36 | /// A function to call once the animation is complete. 37 | /// 38 | /// 39 | }, 40 | toggle: function(handler, handler1, handler2){ 41 | /// 42 | /// Bind two or more handlers to the matched elements, to be executed on alternate clicks. 43 | /// API Reference: http://api.jquery.com/toggle 44 | /// 45 | /// 46 | /// A function to execute every even time the element is clicked. 47 | /// 48 | /// 49 | /// A function to execute every odd time the element is clicked. 50 | /// 51 | /// 52 | /// Additional handlers to cycle through after clicks. 53 | /// 54 | /// 55 | }, 56 | undelegate: function(){ 57 | /// 58 | /// Remove a handler from the event for all elements which match the current selector, now or in the future, based upon a specific set of root elements. 59 | /// Additional Signatures: 60 | /// 1. .undelegate( selector, eventType ) 61 | /// 2. .undelegate( selector, eventType, handler ) 62 | /// API Reference: http://api.jquery.com/undelegate 63 | /// 64 | /// 65 | }, 66 | delegate: function(selector, eventType, handler){ 67 | /// 68 | /// Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements. 69 | /// Additional Signatures: 70 | /// 1. .delegate( selector, eventType, eventData, handler ) 71 | /// API Reference: http://api.jquery.com/delegate 72 | /// 73 | /// 74 | /// A selector to filter the elements that trigger the event. 75 | /// 76 | /// 77 | /// A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," or custom event names. 78 | /// 79 | /// 80 | /// A function to execute at the time the event is triggered. 81 | /// 82 | /// 83 | }, 84 | focusout: function(handler){ 85 | /// 86 | /// Bind an event handler to the "focusout" JavaScript event. 87 | /// Additional Signatures: 88 | /// 1. .focusout( [eventData], handler ) 89 | /// API Reference: http://api.jquery.com/focusout 90 | /// 91 | /// 92 | /// A function to execute each time the event is triggered. 93 | /// 94 | /// 95 | }, 96 | focusin: function(handler){ 97 | /// 98 | /// Bind an event handler to the "focusin" JavaScript event. 99 | /// Additional Signatures: 100 | /// 1. .focusin( [eventData], handler ) 101 | /// API Reference: http://api.jquery.com/focusin 102 | /// 103 | /// 104 | /// A function to execute each time the event is triggered. 105 | /// 106 | /// 107 | }, 108 | has: function(selector){ 109 | /// 110 | /// Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element. 111 | /// Additional Signatures: 112 | /// 1. .has( contained ) 113 | /// API Reference: http://api.jquery.com/has 114 | /// 115 | /// 116 | /// A string containing a selector expression to match elements against. 117 | /// 118 | /// 119 | }, 120 | delay: function(duration, queueName){ 121 | /// 122 | /// Set a timer to delay execution of subsequent items in the queue. 123 | /// API Reference: http://api.jquery.com/delay 124 | /// 125 | /// 126 | /// An integer indicating the number of milliseconds to delay execution of the next item in the queue. 127 | /// 128 | /// 129 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 130 | /// 131 | /// 132 | }, 133 | parentsUntil: function(selector){ 134 | /// 135 | /// Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector. 136 | /// API Reference: http://api.jquery.com/parentsUntil 137 | /// 138 | /// 139 | /// A string containing a selector expression to indicate where to stop matching ancestor elements. 140 | /// 141 | /// 142 | }, 143 | prevUntil: function(selector){ 144 | /// 145 | /// Get all preceding siblings of each element up to but not including the element matched by the selector. 146 | /// API Reference: http://api.jquery.com/prevUntil 147 | /// 148 | /// 149 | /// A string containing a selector expression to indicate where to stop matching preceding sibling elements. 150 | /// 151 | /// 152 | }, 153 | nextUntil: function(selector){ 154 | /// 155 | /// Get all following siblings of each element up to but not including the element matched by the selector. 156 | /// API Reference: http://api.jquery.com/nextUntil 157 | /// 158 | /// 159 | /// A string containing a selector expression to indicate where to stop matching following sibling elements. 160 | /// 161 | /// 162 | }, 163 | each: function(method){ 164 | /// 165 | /// Iterate over a jQuery object, executing a function for each matched element. 166 | /// API Reference: http://api.jquery.com/each 167 | /// 168 | /// 169 | /// A function to execute for each matched element. 170 | /// 171 | /// 172 | }, 173 | pushStack: function(elements){ 174 | /// 175 | /// Add a collection of DOM elements onto the jQuery stack. 176 | /// Additional Signatures: 177 | /// 1. .pushStack( elements, name, arguments ) 178 | /// API Reference: http://api.jquery.com/pushStack 179 | /// 180 | /// 181 | /// An array of elements to push onto the stack and make into a new jQuery object. 182 | /// 183 | /// 184 | }, 185 | clearQueue: function(queueName){ 186 | /// 187 | /// Remove from the queue all items that have not yet been run. 188 | /// API Reference: http://api.jquery.com/clearQueue 189 | /// 190 | /// 191 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 192 | /// 193 | /// 194 | }, 195 | toArray: function(){ 196 | /// 197 | /// Retrieve all the DOM elements contained in the jQuery set, as an array. 198 | /// API Reference: http://api.jquery.com/toArray 199 | /// 200 | /// 201 | }, 202 | keydown: function(handler){ 203 | /// 204 | /// Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element. 205 | /// Additional Signatures: 206 | /// 1. .keydown( [eventData], handler ) 207 | /// 2. .keydown( ) 208 | /// API Reference: http://api.jquery.com/keydown 209 | /// 210 | /// 211 | /// A function to execute each time the event is triggered. 212 | /// 213 | /// 214 | }, 215 | index: function(){ 216 | /// 217 | /// Search for a given element from among the matched elements. 218 | /// Additional Signatures: 219 | /// 1. .index( selector ) 220 | /// 2. .index( element ) 221 | /// API Reference: http://api.jquery.com/index 222 | /// 223 | /// 224 | }, 225 | removeData: function(name){ 226 | /// 227 | /// Remove a previously-stored piece of data. 228 | /// API Reference: http://api.jquery.com/removeData 229 | /// 230 | /// 231 | /// A string naming the piece of data to delete. 232 | /// 233 | /// 234 | }, 235 | data: function(key, value){ 236 | /// 237 | /// Store arbitrary data associated with the matched elements. 238 | /// Additional Signatures: 239 | /// 1. .data( obj ) 240 | /// API Reference: http://api.jquery.com/data 241 | /// 242 | /// 243 | /// A string naming the piece of data to set. 244 | /// 245 | /// 246 | /// The new data value; it can be any Javascript type including Array or Object. 247 | /// 248 | /// 249 | }, 250 | data: function(key){ 251 | /// 252 | /// Returns value at named data store for the first element in the jQuery collection, as set by data(name, value). 253 | /// Additional Signatures: 254 | /// 1. .data( ) 255 | /// API Reference: http://api.jquery.com/data 256 | /// 257 | /// 258 | /// Name of the data stored. 259 | /// 260 | /// 261 | }, 262 | get: function(index){ 263 | /// 264 | /// Retrieve the DOM elements matched by the jQuery object. 265 | /// API Reference: http://api.jquery.com/get 266 | /// 267 | /// 268 | /// A zero-based integer indicating which element to retrieve. 269 | /// 270 | /// 271 | }, 272 | size: function(){ 273 | /// 274 | /// Return the number of DOM elements matched by the jQuery object. 275 | /// API Reference: http://api.jquery.com/size 276 | /// 277 | /// 278 | }, 279 | scroll: function(handler){ 280 | /// 281 | /// Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element. 282 | /// Additional Signatures: 283 | /// 1. .scroll( [eventData], handler ) 284 | /// 2. .scroll( ) 285 | /// API Reference: http://api.jquery.com/scroll 286 | /// 287 | /// 288 | /// A function to execute each time the event is triggered. 289 | /// 290 | /// 291 | }, 292 | resize: function(handler){ 293 | /// 294 | /// Bind an event handler to the "resize" JavaScript event, or trigger that event on an element. 295 | /// Additional Signatures: 296 | /// 1. .resize( [eventData], handler ) 297 | /// 2. .resize( ) 298 | /// API Reference: http://api.jquery.com/resize 299 | /// 300 | /// 301 | /// A function to execute each time the event is triggered. 302 | /// 303 | /// 304 | }, 305 | dequeue: function(queueName){ 306 | /// 307 | /// Execute the next function on the queue for the matched elements. 308 | /// API Reference: http://api.jquery.com/dequeue 309 | /// 310 | /// 311 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 312 | /// 313 | /// 314 | }, 315 | queue: function(queueName){ 316 | /// 317 | /// Show the queue of functions to be executed on the matched elements. 318 | /// API Reference: http://api.jquery.com/queue 319 | /// 320 | /// 321 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 322 | /// 323 | /// 324 | }, 325 | queue: function(queueName, newQueue){ 326 | /// 327 | /// Manipulate the queue of functions to be executed on the matched elements. 328 | /// Additional Signatures: 329 | /// 1. .queue( [queueName], method ) 330 | /// API Reference: http://api.jquery.com/queue 331 | /// 332 | /// 333 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 334 | /// 335 | /// 336 | /// An array of functions to replace the current queue contents. 337 | /// 338 | /// 339 | }, 340 | keyup: function(handler){ 341 | /// 342 | /// Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element. 343 | /// Additional Signatures: 344 | /// 1. .keyup( [eventData], handler ) 345 | /// 2. .keyup( ) 346 | /// API Reference: http://api.jquery.com/keyup 347 | /// 348 | /// 349 | /// A function to execute each time the event is triggered. 350 | /// 351 | /// 352 | }, 353 | keypress: function(handler){ 354 | /// 355 | /// Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element. 356 | /// Additional Signatures: 357 | /// 1. .keypress( [eventData], handler ) 358 | /// 2. .keypress( ) 359 | /// API Reference: http://api.jquery.com/keypress 360 | /// 361 | /// 362 | /// A function to execute each time the event is triggered. 363 | /// 364 | /// 365 | }, 366 | submit: function(handler){ 367 | /// 368 | /// Bind an event handler to the "submit" JavaScript event, or trigger that event on an element. 369 | /// Additional Signatures: 370 | /// 1. .submit( [eventData], handler ) 371 | /// 2. .submit( ) 372 | /// API Reference: http://api.jquery.com/submit 373 | /// 374 | /// 375 | /// A function to execute each time the event is triggered. 376 | /// 377 | /// 378 | }, 379 | select: function(handler){ 380 | /// 381 | /// Bind an event handler to the "select" JavaScript event, or trigger that event on an element. 382 | /// Additional Signatures: 383 | /// 1. .select( [eventData], handler ) 384 | /// 2. .select( ) 385 | /// API Reference: http://api.jquery.com/select 386 | /// 387 | /// 388 | /// A function to execute each time the event is triggered. 389 | /// 390 | /// 391 | }, 392 | change: function(handler){ 393 | /// 394 | /// Bind an event handler to the "change" JavaScript event, or trigger that event on an element. 395 | /// Additional Signatures: 396 | /// 1. .change( [eventData], handler ) 397 | /// 2. .change( ) 398 | /// API Reference: http://api.jquery.com/change 399 | /// 400 | /// 401 | /// A function to execute each time the event is triggered. 402 | /// 403 | /// 404 | }, 405 | blur: function(handler){ 406 | /// 407 | /// Bind an event handler to the "blur" JavaScript event, or trigger that event on an element. 408 | /// Additional Signatures: 409 | /// 1. .blur( [eventData], handler ) 410 | /// 2. .blur( ) 411 | /// API Reference: http://api.jquery.com/blur 412 | /// 413 | /// 414 | /// A function to execute each time the event is triggered. 415 | /// 416 | /// 417 | }, 418 | focus: function(handler){ 419 | /// 420 | /// Bind an event handler to the "focus" JavaScript event, or trigger that event on an element. 421 | /// Additional Signatures: 422 | /// 1. .focus( [eventData], handler ) 423 | /// 2. .focus( ) 424 | /// API Reference: http://api.jquery.com/focus 425 | /// 426 | /// 427 | /// A function to execute each time the event is triggered. 428 | /// 429 | /// 430 | }, 431 | mousemove: function(handler){ 432 | /// 433 | /// Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element. 434 | /// Additional Signatures: 435 | /// 1. .mousemove( [eventData], handler ) 436 | /// 2. .mousemove( ) 437 | /// API Reference: http://api.jquery.com/mousemove 438 | /// 439 | /// 440 | /// A function to execute each time the event is triggered. 441 | /// 442 | /// 443 | }, 444 | hover: function(handler, handler1){ 445 | /// 446 | /// Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements. 447 | /// API Reference: http://api.jquery.com/hover 448 | /// 449 | /// 450 | /// A function to execute when the mouse pointer enters the element. 451 | /// 452 | /// 453 | /// A function to execute when the mouse pointer leaves the element. 454 | /// 455 | /// 456 | }, 457 | hover: function(handler){ 458 | /// 459 | /// Bind a single handler to the matched elements, to be executed when the mouse pointer enters or leaves the elements. 460 | /// API Reference: http://api.jquery.com/hover 461 | /// 462 | /// 463 | /// A function to execute when the mouse pointer enters or leaves the element. 464 | /// 465 | /// 466 | }, 467 | mouseleave: function(handler){ 468 | /// 469 | /// Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element. 470 | /// Additional Signatures: 471 | /// 1. .mouseleave( [eventData], handler ) 472 | /// 2. .mouseleave( ) 473 | /// API Reference: http://api.jquery.com/mouseleave 474 | /// 475 | /// 476 | /// A function to execute each time the event is triggered. 477 | /// 478 | /// 479 | }, 480 | mouseenter: function(handler){ 481 | /// 482 | /// Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element. 483 | /// Additional Signatures: 484 | /// 1. .mouseenter( [eventData], handler ) 485 | /// 2. .mouseenter( ) 486 | /// API Reference: http://api.jquery.com/mouseenter 487 | /// 488 | /// 489 | /// A function to execute each time the event is triggered. 490 | /// 491 | /// 492 | }, 493 | mouseout: function(handler){ 494 | /// 495 | /// Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element. 496 | /// Additional Signatures: 497 | /// 1. .mouseout( [eventData], handler ) 498 | /// 2. .mouseout( ) 499 | /// API Reference: http://api.jquery.com/mouseout 500 | /// 501 | /// 502 | /// A function to execute each time the event is triggered. 503 | /// 504 | /// 505 | }, 506 | mouseover: function(handler){ 507 | /// 508 | /// Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element. 509 | /// Additional Signatures: 510 | /// 1. .mouseover( [eventData], handler ) 511 | /// 2. .mouseover( ) 512 | /// API Reference: http://api.jquery.com/mouseover 513 | /// 514 | /// 515 | /// A function to execute each time the event is triggered. 516 | /// 517 | /// 518 | }, 519 | dblclick: function(handler){ 520 | /// 521 | /// Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element. 522 | /// Additional Signatures: 523 | /// 1. .dblclick( [eventData], handler ) 524 | /// 2. .dblclick( ) 525 | /// API Reference: http://api.jquery.com/dblclick 526 | /// 527 | /// 528 | /// A function to execute each time the event is triggered. 529 | /// 530 | /// 531 | }, 532 | click: function(handler){ 533 | /// 534 | /// Bind an event handler to the "click" JavaScript event, or trigger that event on an element. 535 | /// Additional Signatures: 536 | /// 1. .click( [eventData], handler ) 537 | /// 2. .click( ) 538 | /// API Reference: http://api.jquery.com/click 539 | /// 540 | /// 541 | /// A function to execute each time the event is triggered. 542 | /// 543 | /// 544 | }, 545 | mouseup: function(handler){ 546 | /// 547 | /// Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element. 548 | /// Additional Signatures: 549 | /// 1. .mouseup( [eventData], handler ) 550 | /// 2. .mouseup( ) 551 | /// API Reference: http://api.jquery.com/mouseup 552 | /// 553 | /// 554 | /// A function to execute each time the event is triggered. 555 | /// 556 | /// 557 | }, 558 | mousedown: function(handler){ 559 | /// 560 | /// Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element. 561 | /// Additional Signatures: 562 | /// 1. .mousedown( [eventData], handler ) 563 | /// 2. .mousedown( ) 564 | /// API Reference: http://api.jquery.com/mousedown 565 | /// 566 | /// 567 | /// A function to execute each time the event is triggered. 568 | /// 569 | /// 570 | }, 571 | error: function(handler){ 572 | /// 573 | /// Bind an event handler to the "error" JavaScript event. 574 | /// Additional Signatures: 575 | /// 1. .error( [eventData], handler ) 576 | /// API Reference: http://api.jquery.com/error 577 | /// 578 | /// 579 | /// A function to execute when the event is triggered. 580 | /// 581 | /// 582 | }, 583 | unload: function(handler){ 584 | /// 585 | /// Bind an event handler to the "unload" JavaScript event. 586 | /// Additional Signatures: 587 | /// 1. .unload( [eventData], handler ) 588 | /// API Reference: http://api.jquery.com/unload 589 | /// 590 | /// 591 | /// A function to execute when the event is triggered. 592 | /// 593 | /// 594 | }, 595 | load: function(handler){ 596 | /// 597 | /// Bind an event handler to the "load" JavaScript event. 598 | /// Additional Signatures: 599 | /// 1. .load( [eventData], handler ) 600 | /// API Reference: http://api.jquery.com/load 601 | /// 602 | /// 603 | /// A function to execute when the event is triggered. 604 | /// 605 | /// 606 | }, 607 | ready: function(handler){ 608 | /// 609 | /// Specify a function to execute when the DOM is fully loaded. 610 | /// API Reference: http://api.jquery.com/ready 611 | /// 612 | /// 613 | /// A function to execute after the DOM is ready. 614 | /// 615 | /// 616 | }, 617 | die: function(){ 618 | /// 619 | /// Remove all event handlers previously attached using .live() from the elements. 620 | /// API Reference: http://api.jquery.com/die 621 | /// 622 | /// 623 | }, 624 | die: function(eventType, handler){ 625 | /// 626 | /// Remove an event handler previously attached using .live() from the elements. 627 | /// API Reference: http://api.jquery.com/die 628 | /// 629 | /// 630 | /// A string containing a JavaScript event type, such as click or keydown. 631 | /// 632 | /// 633 | /// The function that is to be no longer executed. 634 | /// 635 | /// 636 | }, 637 | live: function(eventType, handler){ 638 | /// 639 | /// Attach a handler to the event for all elements which match the current selector, now and in the future. 640 | /// Additional Signatures: 641 | /// 1. .live( eventType, eventData, handler ) 642 | /// API Reference: http://api.jquery.com/live 643 | /// 644 | /// 645 | /// A string containing a JavaScript event type, such as "click" or "keydown." As of jQuery 1.4 the string can contain multiple, space-separated event types or custom event names, as well. 646 | /// 647 | /// 648 | /// A function to execute at the time the event is triggered. 649 | /// 650 | /// 651 | }, 652 | triggerHandler: function(eventType, extraParameters){ 653 | /// 654 | /// Execute all handlers attached to an element for an event. 655 | /// API Reference: http://api.jquery.com/triggerHandler 656 | /// 657 | /// 658 | /// A string containing a JavaScript event type, such as click or submit. 659 | /// 660 | /// 661 | /// An array of additional parameters to pass along to the event handler. 662 | /// 663 | /// 664 | }, 665 | trigger: function(eventType, extraParameters){ 666 | /// 667 | /// Execute all handlers and behaviors attached to the matched elements for the given event type. 668 | /// Additional Signatures: 669 | /// 1. .trigger( event ) 670 | /// API Reference: http://api.jquery.com/trigger 671 | /// 672 | /// 673 | /// A string containing a JavaScript event type, such as click or submit. 674 | /// 675 | /// 676 | /// An array of additional parameters to pass along to the event handler. 677 | /// 678 | /// 679 | }, 680 | ajaxComplete: function(handler){ 681 | /// 682 | /// Register a handler to be called when Ajax requests complete. This is an Ajax Event. 683 | /// API Reference: http://api.jquery.com/ajaxComplete 684 | /// 685 | /// 686 | /// The function to be invoked. 687 | /// 688 | /// 689 | }, 690 | one: function(eventType, eventData, handler){ 691 | /// 692 | /// Attach a handler to an event for the elements. The handler is executed at most once per element. 693 | /// API Reference: http://api.jquery.com/one 694 | /// 695 | /// 696 | /// A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names. 697 | /// 698 | /// 699 | /// A map of data that will be passed to the event handler. 700 | /// 701 | /// 702 | /// A function to execute at the time the event is triggered. 703 | /// 704 | /// 705 | }, 706 | serializeArray: function(){ 707 | /// 708 | /// Encode a set of form elements as an array of names and values. 709 | /// API Reference: http://api.jquery.com/serializeArray 710 | /// 711 | /// 712 | }, 713 | serialize: function(){ 714 | /// 715 | /// Encode a set of form elements as a string for submission. 716 | /// API Reference: http://api.jquery.com/serialize 717 | /// 718 | /// 719 | }, 720 | ajaxSuccess: function(handler){ 721 | /// 722 | /// Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event. 723 | /// API Reference: http://api.jquery.com/ajaxSuccess 724 | /// 725 | /// 726 | /// The function to be invoked. 727 | /// 728 | /// 729 | }, 730 | ajaxStop: function(handler){ 731 | /// 732 | /// Register a handler to be called when all Ajax requests have completed. This is an Ajax Event. 733 | /// API Reference: http://api.jquery.com/ajaxStop 734 | /// 735 | /// 736 | /// The function to be invoked. 737 | /// 738 | /// 739 | }, 740 | ajaxStart: function(handler){ 741 | /// 742 | /// Register a handler to be called when the first Ajax request begins. This is an Ajax Event. 743 | /// API Reference: http://api.jquery.com/ajaxStart 744 | /// 745 | /// 746 | /// The function to be invoked. 747 | /// 748 | /// 749 | }, 750 | ajaxSend: function(handler){ 751 | /// 752 | /// Attach a function to be executed before an Ajax request is sent. This is an Ajax Event. 753 | /// API Reference: http://api.jquery.com/ajaxSend 754 | /// 755 | /// 756 | /// The function to be invoked. 757 | /// 758 | /// 759 | }, 760 | ajaxError: function(handler){ 761 | /// 762 | /// Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event. 763 | /// API Reference: http://api.jquery.com/ajaxError 764 | /// 765 | /// 766 | /// The function to be invoked. 767 | /// 768 | /// 769 | }, 770 | unbind: function(eventType, handler){ 771 | /// 772 | /// Remove a previously-attached event handler from the elements. 773 | /// Additional Signatures: 774 | /// 1. .unbind( eventType, false ) 775 | /// 2. .unbind( event ) 776 | /// API Reference: http://api.jquery.com/unbind 777 | /// 778 | /// 779 | /// A string containing a JavaScript event type, such as click or submit. 780 | /// 781 | /// 782 | /// The function that is to be no longer executed. 783 | /// 784 | /// 785 | }, 786 | bind: function(eventType, eventData, handler){ 787 | /// 788 | /// Attach a handler to an event for the elements. 789 | /// Additional Signatures: 790 | /// 1. .bind( eventType, [eventData], false ) 791 | /// 2. .bind( events ) 792 | /// API Reference: http://api.jquery.com/bind 793 | /// 794 | /// 795 | /// A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names. 796 | /// 797 | /// 798 | /// A map of data that will be passed to the event handler. 799 | /// 800 | /// 801 | /// A function to execute each time the event is triggered. 802 | /// 803 | /// 804 | }, 805 | first: function(){ 806 | /// 807 | /// Reduce the set of matched elements to the first in the set. 808 | /// API Reference: http://api.jquery.com/first 809 | /// 810 | /// 811 | }, 812 | last: function(){ 813 | /// 814 | /// Reduce the set of matched elements to the final one in the set. 815 | /// API Reference: http://api.jquery.com/last 816 | /// 817 | /// 818 | }, 819 | slice: function(start, end){ 820 | /// 821 | /// Reduce the set of matched elements to a subset specified by a range of indices. 822 | /// API Reference: http://api.jquery.com/slice 823 | /// 824 | /// 825 | /// An integer indicating the 0-based position at which the elements begin to be selected. If negative, it indicates an offset from the end of the set. 826 | /// 827 | /// 828 | /// An integer indicating the 0-based position at which the elements stop being selected. If negative, it indicates an offset from the end of the set. If omitted, the range continues until the end of the set. 829 | /// 830 | /// 831 | }, 832 | stop: function(clearQueue, jumpToEnd){ 833 | /// 834 | /// Stop the currently-running animation on the matched elements. 835 | /// API Reference: http://api.jquery.com/stop 836 | /// 837 | /// 838 | /// A Boolean indicating whether to remove queued animation as well. Defaults to false. 839 | /// 840 | /// 841 | /// A Boolean indicating whether to complete the current animation immediately. Defaults to false. 842 | /// 843 | /// 844 | }, 845 | end: function(){ 846 | /// 847 | /// End the most recent filtering operation in the current chain and return the set of matched elements to its previous state. 848 | /// API Reference: http://api.jquery.com/end 849 | /// 850 | /// 851 | }, 852 | andSelf: function(){ 853 | /// 854 | /// Add the previous set of elements on the stack to the current set. 855 | /// API Reference: http://api.jquery.com/andSelf 856 | /// 857 | /// 858 | }, 859 | siblings: function(selector){ 860 | /// 861 | /// Get the siblings of each element in the set of matched elements, optionally filtered by a selector. 862 | /// API Reference: http://api.jquery.com/siblings 863 | /// 864 | /// 865 | /// A string containing a selector expression to match elements against. 866 | /// 867 | /// 868 | }, 869 | animate: function(properties, duration, easing, complete){ 870 | /// 871 | /// Perform a custom animation of a set of CSS properties. 872 | /// Additional Signatures: 873 | /// 1. .animate( properties, options ) 874 | /// API Reference: http://api.jquery.com/animate 875 | /// 876 | /// 877 | /// A map of CSS properties that the animation will move toward. 878 | /// 879 | /// 880 | /// A string or number determining how long the animation will run. 881 | /// 882 | /// 883 | /// A string indicating which easing function to use for the transition. 884 | /// 885 | /// 886 | /// A function to call once the animation is complete. 887 | /// 888 | /// 889 | }, 890 | prevAll: function(selector){ 891 | /// 892 | /// Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector. 893 | /// API Reference: http://api.jquery.com/prevAll 894 | /// 895 | /// 896 | /// A string containing a selector expression to match elements against. 897 | /// 898 | /// 899 | }, 900 | prev: function(selector){ 901 | /// 902 | /// Get the immediately preceding sibling of each element in the set of matched elements, optionally filtered by a selector. 903 | /// API Reference: http://api.jquery.com/prev 904 | /// 905 | /// 906 | /// A string containing a selector expression to match elements against. 907 | /// 908 | /// 909 | }, 910 | fadeTo: function(duration, opacity, callback){ 911 | /// 912 | /// Adjust the opacity of the matched elements. 913 | /// Additional Signatures: 914 | /// 1. .fadeTo( duration, opacity, [easing], [callback] ) 915 | /// API Reference: http://api.jquery.com/fadeTo 916 | /// 917 | /// 918 | /// A string or number determining how long the animation will run. 919 | /// 920 | /// 921 | /// A number between 0 and 1 denoting the target opacity. 922 | /// 923 | /// 924 | /// A function to call once the animation is complete. 925 | /// 926 | /// 927 | }, 928 | fadeOut: function(duration, callback){ 929 | /// 930 | /// Hide the matched elements by fading them to transparent. 931 | /// Additional Signatures: 932 | /// 1. .fadeOut( [duration], [easing], [callback] ) 933 | /// API Reference: http://api.jquery.com/fadeOut 934 | /// 935 | /// 936 | /// A string or number determining how long the animation will run. 937 | /// 938 | /// 939 | /// A function to call once the animation is complete. 940 | /// 941 | /// 942 | }, 943 | parents: function(selector){ 944 | /// 945 | /// Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector. 946 | /// API Reference: http://api.jquery.com/parents 947 | /// 948 | /// 949 | /// A string containing a selector expression to match elements against. 950 | /// 951 | /// 952 | }, 953 | fadeIn: function(duration, callback){ 954 | /// 955 | /// Display the matched elements by fading them to opaque. 956 | /// Additional Signatures: 957 | /// 1. .fadeIn( [duration], [easing], [callback] ) 958 | /// API Reference: http://api.jquery.com/fadeIn 959 | /// 960 | /// 961 | /// A string or number determining how long the animation will run. 962 | /// 963 | /// 964 | /// A function to call once the animation is complete. 965 | /// 966 | /// 967 | }, 968 | parent: function(selector){ 969 | /// 970 | /// Get the parent of each element in the current set of matched elements, optionally filtered by a selector. 971 | /// API Reference: http://api.jquery.com/parent 972 | /// 973 | /// 974 | /// A string containing a selector expression to match elements against. 975 | /// 976 | /// 977 | }, 978 | offsetParent: function(){ 979 | /// 980 | /// Get the closest ancestor element that is positioned. 981 | /// API Reference: http://api.jquery.com/offsetParent 982 | /// 983 | /// 984 | }, 985 | slideToggle: function(duration, callback){ 986 | /// 987 | /// Display or hide the matched elements with a sliding motion. 988 | /// Additional Signatures: 989 | /// 1. .slideToggle( [duration], [easing], [callback] ) 990 | /// API Reference: http://api.jquery.com/slideToggle 991 | /// 992 | /// 993 | /// A string or number determining how long the animation will run. 994 | /// 995 | /// 996 | /// A function to call once the animation is complete. 997 | /// 998 | /// 999 | }, 1000 | slideUp: function(duration, callback){ 1001 | /// 1002 | /// Hide the matched elements with a sliding motion. 1003 | /// Additional Signatures: 1004 | /// 1. .slideUp( [duration], [easing], [callback] ) 1005 | /// API Reference: http://api.jquery.com/slideUp 1006 | /// 1007 | /// 1008 | /// A string or number determining how long the animation will run. 1009 | /// 1010 | /// 1011 | /// A function to call once the animation is complete. 1012 | /// 1013 | /// 1014 | }, 1015 | nextAll: function(selector){ 1016 | /// 1017 | /// Get all following siblings of each element in the set of matched elements, optionally filtered by a selector. 1018 | /// API Reference: http://api.jquery.com/nextAll 1019 | /// 1020 | /// 1021 | /// A string containing a selector expression to match elements against. 1022 | /// 1023 | /// 1024 | }, 1025 | next: function(selector){ 1026 | /// 1027 | /// Get the immediately following sibling of each element in the set of matched elements. If a selector is provided, it retrieves the next sibling only if it matches that selector. 1028 | /// API Reference: http://api.jquery.com/next 1029 | /// 1030 | /// 1031 | /// A string containing a selector expression to match elements against. 1032 | /// 1033 | /// 1034 | }, 1035 | slideDown: function(duration, callback){ 1036 | /// 1037 | /// Display the matched elements with a sliding motion. 1038 | /// Additional Signatures: 1039 | /// 1. .slideDown( [duration], [easing], [callback] ) 1040 | /// API Reference: http://api.jquery.com/slideDown 1041 | /// 1042 | /// 1043 | /// A string or number determining how long the animation will run. 1044 | /// 1045 | /// 1046 | /// A function to call once the animation is complete. 1047 | /// 1048 | /// 1049 | }, 1050 | find: function(selector){ 1051 | /// 1052 | /// Get the descendants of each element in the current set of matched elements, filtered by a selector. 1053 | /// API Reference: http://api.jquery.com/find 1054 | /// 1055 | /// 1056 | /// A string containing a selector expression to match elements against. 1057 | /// 1058 | /// 1059 | }, 1060 | contents: function(){ 1061 | /// 1062 | /// Get the children of each element in the set of matched elements, including text and comment nodes. 1063 | /// API Reference: http://api.jquery.com/contents 1064 | /// 1065 | /// 1066 | }, 1067 | closest: function(selector){ 1068 | /// 1069 | /// Get the first ancestor element that matches the selector, beginning at the current element and progressing up through the DOM tree. 1070 | /// Additional Signatures: 1071 | /// 1. .closest( selector, [context] ) 1072 | /// API Reference: http://api.jquery.com/closest 1073 | /// 1074 | /// 1075 | /// A string containing a selector expression to match elements against. 1076 | /// 1077 | /// 1078 | }, 1079 | closest: function(selectors, context){ 1080 | /// 1081 | /// Gets an array of all the elements and selectors matched against the current element up through the DOM tree. 1082 | /// API Reference: http://api.jquery.com/closest 1083 | /// 1084 | /// 1085 | /// An array or string containing a selector expression to match elements against (can also be a jQuery object). 1086 | /// 1087 | /// 1088 | /// A DOM element within which a matching element may be found. If no context is passed in then the context of the jQuery set will be used instead. 1089 | /// 1090 | /// 1091 | }, 1092 | load: function(url, data, method){ 1093 | /// 1094 | /// Load data from the server and place the returned HTML into the matched element. 1095 | /// API Reference: http://api.jquery.com/load 1096 | /// 1097 | /// 1098 | /// A string containing the URL to which the request is sent. 1099 | /// 1100 | /// 1101 | /// A map or string that is sent to the server with the request. 1102 | /// 1103 | /// 1104 | /// A callback function that is executed when the request completes. 1105 | /// 1106 | /// 1107 | }, 1108 | children: function(selector){ 1109 | /// 1110 | /// Get the children of each element in the set of matched elements, optionally filtered by a selector. 1111 | /// API Reference: http://api.jquery.com/children 1112 | /// 1113 | /// 1114 | /// A string containing a selector expression to match elements against. 1115 | /// 1116 | /// 1117 | }, 1118 | add: function(selector){ 1119 | /// 1120 | /// Add elements to the set of matched elements. 1121 | /// Additional Signatures: 1122 | /// 1. .add( elements ) 1123 | /// 2. .add( html ) 1124 | /// 3. .add( selector, context ) 1125 | /// API Reference: http://api.jquery.com/add 1126 | /// 1127 | /// 1128 | /// A string containing a selector expression to match additional elements against. 1129 | /// 1130 | /// 1131 | }, 1132 | not: function(selector){ 1133 | /// 1134 | /// Remove elements from the set of matched elements. 1135 | /// Additional Signatures: 1136 | /// 1. .not( elements ) 1137 | /// 2. .not( method ) 1138 | /// API Reference: http://api.jquery.com/not 1139 | /// 1140 | /// 1141 | /// A string containing a selector expression to match elements against. 1142 | /// 1143 | /// 1144 | }, 1145 | outerWidth: function(includeMargin){ 1146 | /// 1147 | /// Get the current computed width for the first element in the set of matched elements, including padding and border. 1148 | /// API Reference: http://api.jquery.com/outerWidth 1149 | /// 1150 | /// 1151 | /// A Boolean indicating whether to include the element's margin in the calculation. 1152 | /// 1153 | /// 1154 | }, 1155 | outerHeight: function(includeMargin){ 1156 | /// 1157 | /// Get the current computed height for the first element in the set of matched elements, including padding, border, and optionally margin. 1158 | /// API Reference: http://api.jquery.com/outerHeight 1159 | /// 1160 | /// 1161 | /// A Boolean indicating whether to include the element's margin in the calculation. 1162 | /// 1163 | /// 1164 | }, 1165 | toggle: function(duration, callback){ 1166 | /// 1167 | /// Display or hide the matched elements. 1168 | /// Additional Signatures: 1169 | /// 1. .toggle( [duration], [easing], [callback] ) 1170 | /// 2. .toggle( showOrHide ) 1171 | /// API Reference: http://api.jquery.com/toggle 1172 | /// 1173 | /// 1174 | /// A string or number determining how long the animation will run. 1175 | /// 1176 | /// 1177 | /// A function to call once the animation is complete. 1178 | /// 1179 | /// 1180 | }, 1181 | innerWidth: function(){ 1182 | /// 1183 | /// Get the current computed width for the first element in the set of matched elements, including padding but not border. 1184 | /// API Reference: http://api.jquery.com/innerWidth 1185 | /// 1186 | /// 1187 | }, 1188 | innerHeight: function(){ 1189 | /// 1190 | /// Get the current computed height for the first element in the set of matched elements, including padding but not border. 1191 | /// API Reference: http://api.jquery.com/innerHeight 1192 | /// 1193 | /// 1194 | }, 1195 | hide: function(){ 1196 | /// 1197 | /// Hide the matched elements. 1198 | /// Additional Signatures: 1199 | /// 1. .hide( duration, [callback] ) 1200 | /// 2. .hide( [duration], [easing], [callback] ) 1201 | /// API Reference: http://api.jquery.com/hide 1202 | /// 1203 | /// 1204 | }, 1205 | width: function(){ 1206 | /// 1207 | /// Get the current computed width for the first element in the set of matched elements. 1208 | /// API Reference: http://api.jquery.com/width 1209 | /// 1210 | /// 1211 | }, 1212 | width: function(value){ 1213 | /// 1214 | /// Set the CSS width of each element in the set of matched elements. 1215 | /// Additional Signatures: 1216 | /// 1. .width( method ) 1217 | /// API Reference: http://api.jquery.com/width 1218 | /// 1219 | /// 1220 | /// An integer representing the number of pixels, or an integer along with an optional unit of measure appended (as a string). 1221 | /// 1222 | /// 1223 | }, 1224 | height: function(){ 1225 | /// 1226 | /// Get the current computed height for the first element in the set of matched elements. 1227 | /// API Reference: http://api.jquery.com/height 1228 | /// 1229 | /// 1230 | }, 1231 | height: function(value){ 1232 | /// 1233 | /// Set the CSS height of every matched element. 1234 | /// Additional Signatures: 1235 | /// 1. .height( method ) 1236 | /// API Reference: http://api.jquery.com/height 1237 | /// 1238 | /// 1239 | /// An integer representing the number of pixels, or an integer with an optional unit of measure appended (as a string). 1240 | /// 1241 | /// 1242 | }, 1243 | show: function(){ 1244 | /// 1245 | /// Display the matched elements. 1246 | /// Additional Signatures: 1247 | /// 1. .show( duration, [callback] ) 1248 | /// 2. .show( [duration], [easing], [callback] ) 1249 | /// API Reference: http://api.jquery.com/show 1250 | /// 1251 | /// 1252 | }, 1253 | scrollLeft: function(){ 1254 | /// 1255 | /// Get the current horizontal position of the scroll bar for the first element in the set of matched elements. 1256 | /// API Reference: http://api.jquery.com/scrollLeft 1257 | /// 1258 | /// 1259 | }, 1260 | scrollLeft: function(value){ 1261 | /// 1262 | /// Set the current horizontal position of the scroll bar for each of the set of matched elements. 1263 | /// API Reference: http://api.jquery.com/scrollLeft 1264 | /// 1265 | /// 1266 | /// An integer indicating the new position to set the scroll bar to. 1267 | /// 1268 | /// 1269 | }, 1270 | scrollTop: function(){ 1271 | /// 1272 | /// Get the current vertical position of the scroll bar for the first element in the set of matched elements. 1273 | /// API Reference: http://api.jquery.com/scrollTop 1274 | /// 1275 | /// 1276 | }, 1277 | scrollTop: function(value){ 1278 | /// 1279 | /// Set the current vertical position of the scroll bar for each of the set of matched elements. 1280 | /// API Reference: http://api.jquery.com/scrollTop 1281 | /// 1282 | /// 1283 | /// An integer indicating the new position to set the scroll bar to. 1284 | /// 1285 | /// 1286 | }, 1287 | position: function(){ 1288 | /// 1289 | /// Get the current coordinates of the first element in the set of matched elements, relative to the offset parent. 1290 | /// API Reference: http://api.jquery.com/position 1291 | /// 1292 | /// 1293 | }, 1294 | offset: function(){ 1295 | /// 1296 | /// Get the current coordinates of the first element in the set of matched elements, relative to the document. 1297 | /// API Reference: http://api.jquery.com/offset 1298 | /// 1299 | /// 1300 | }, 1301 | offset: function(coordinates){ 1302 | /// 1303 | /// Set the current coordinates of every element in the set of matched elements, relative to the document. 1304 | /// Additional Signatures: 1305 | /// 1. .offset( method ) 1306 | /// API Reference: http://api.jquery.com/offset 1307 | /// 1308 | /// 1309 | /// An object containing the properties top and left, which are integers indicating the new top and left coordinates for the elements. 1310 | /// 1311 | /// 1312 | }, 1313 | css: function(propertyName){ 1314 | /// 1315 | /// Get the value of a style property for the first element in the set of matched elements. 1316 | /// API Reference: http://api.jquery.com/css 1317 | /// 1318 | /// 1319 | /// A CSS property. 1320 | /// 1321 | /// 1322 | }, 1323 | css: function(propertyName, value){ 1324 | /// 1325 | /// Set one or more CSS properties for the set of matched elements. 1326 | /// Additional Signatures: 1327 | /// 1. .css( propertyName, method ) 1328 | /// 2. .css( map ) 1329 | /// API Reference: http://api.jquery.com/css 1330 | /// 1331 | /// 1332 | /// A CSS property name. 1333 | /// 1334 | /// 1335 | /// A value to set for the property. 1336 | /// 1337 | /// 1338 | }, 1339 | unwrap: function(){ 1340 | /// 1341 | /// Remove the parents of the set of matched elements from the DOM, leaving the matched elements in their place. 1342 | /// API Reference: http://api.jquery.com/unwrap 1343 | /// 1344 | /// 1345 | }, 1346 | detach: function(selector){ 1347 | /// 1348 | /// Remove the set of matched elements from the DOM. 1349 | /// API Reference: http://api.jquery.com/detach 1350 | /// 1351 | /// 1352 | /// A selector expression that filters the set of matched elements to be removed. 1353 | /// 1354 | /// 1355 | }, 1356 | clone: function(withDataAndEvents){ 1357 | /// 1358 | /// Create a deep copy of the set of matched elements. 1359 | /// API Reference: http://api.jquery.com/clone 1360 | /// 1361 | /// 1362 | /// A Boolean indicating whether event handlers should be copied along with the elements. As of jQuery 1.4 element data will be copied as well. 1363 | /// 1364 | /// 1365 | }, 1366 | remove: function(selector){ 1367 | /// 1368 | /// Remove the set of matched elements from the DOM. 1369 | /// API Reference: http://api.jquery.com/remove 1370 | /// 1371 | /// 1372 | /// A selector expression that filters the set of matched elements to be removed. 1373 | /// 1374 | /// 1375 | }, 1376 | empty: function(){ 1377 | /// 1378 | /// Remove all child nodes of the set of matched elements from the DOM. 1379 | /// API Reference: http://api.jquery.com/empty 1380 | /// 1381 | /// 1382 | }, 1383 | replaceAll: function(target){ 1384 | /// 1385 | /// Replace each target element with the set of matched elements. 1386 | /// API Reference: http://api.jquery.com/replaceAll 1387 | /// 1388 | /// 1389 | /// A selector expression indicating which element(s) to replace. 1390 | /// 1391 | /// 1392 | }, 1393 | replaceWith: function(newContent){ 1394 | /// 1395 | /// Replace each element in the set of matched elements with the provided new content. 1396 | /// Additional Signatures: 1397 | /// 1. .replaceWith( method ) 1398 | /// API Reference: http://api.jquery.com/replaceWith 1399 | /// 1400 | /// 1401 | /// The content to insert. May be an HTML string, DOM element, or jQuery object. 1402 | /// 1403 | /// 1404 | }, 1405 | wrapInner: function(wrappingElement){ 1406 | /// 1407 | /// Wrap an HTML structure around the content of each element in the set of matched elements. 1408 | /// Additional Signatures: 1409 | /// 1. .wrapInner( wrappingFunction ) 1410 | /// API Reference: http://api.jquery.com/wrapInner 1411 | /// 1412 | /// 1413 | /// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the content of the matched elements. 1414 | /// 1415 | /// 1416 | }, 1417 | wrapAll: function(wrappingElement){ 1418 | /// 1419 | /// Wrap an HTML structure around all elements in the set of matched elements. 1420 | /// API Reference: http://api.jquery.com/wrapAll 1421 | /// 1422 | /// 1423 | /// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the matched elements. 1424 | /// 1425 | /// 1426 | }, 1427 | wrap: function(wrappingElement){ 1428 | /// 1429 | /// Wrap an HTML structure around each element in the set of matched elements. 1430 | /// Additional Signatures: 1431 | /// 1. .wrap( wrappingFunction ) 1432 | /// API Reference: http://api.jquery.com/wrap 1433 | /// 1434 | /// 1435 | /// An HTML snippet, selector expression, jQuery object, or DOM element specifying the structure to wrap around the matched elements. 1436 | /// 1437 | /// 1438 | }, 1439 | insertBefore: function(target){ 1440 | /// 1441 | /// Insert every element in the set of matched elements before the target. 1442 | /// API Reference: http://api.jquery.com/insertBefore 1443 | /// 1444 | /// 1445 | /// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted before the element(s) specified by this parameter. 1446 | /// 1447 | /// 1448 | }, 1449 | before: function(content){ 1450 | /// 1451 | /// Insert content, specified by the parameter, before each element in the set of matched elements. 1452 | /// Additional Signatures: 1453 | /// 1. .before( method ) 1454 | /// API Reference: http://api.jquery.com/before 1455 | /// 1456 | /// 1457 | /// An element, HTML string, or jQuery object to insert before each element in the set of matched elements. 1458 | /// 1459 | /// 1460 | }, 1461 | insertAfter: function(target){ 1462 | /// 1463 | /// Insert every element in the set of matched elements after the target. 1464 | /// API Reference: http://api.jquery.com/insertAfter 1465 | /// 1466 | /// 1467 | /// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted after the element(s) specified by this parameter. 1468 | /// 1469 | /// 1470 | }, 1471 | after: function(content){ 1472 | /// 1473 | /// Insert content, specified by the parameter, after each element in the set of matched elements. 1474 | /// Additional Signatures: 1475 | /// 1. .after( method ) 1476 | /// API Reference: http://api.jquery.com/after 1477 | /// 1478 | /// 1479 | /// An element, HTML string, or jQuery object to insert after each element in the set of matched elements. 1480 | /// 1481 | /// 1482 | }, 1483 | prependTo: function(target){ 1484 | /// 1485 | /// Insert every element in the set of matched elements to the beginning of the target. 1486 | /// API Reference: http://api.jquery.com/prependTo 1487 | /// 1488 | /// 1489 | /// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted at the beginning of the element(s) specified by this parameter. 1490 | /// 1491 | /// 1492 | }, 1493 | prepend: function(content, content1){ 1494 | /// 1495 | /// Insert content, specified by the parameter, to the beginning of each element in the set of matched elements. 1496 | /// Additional Signatures: 1497 | /// 1. .prepend( method ) 1498 | /// API Reference: http://api.jquery.com/prepend 1499 | /// 1500 | /// 1501 | /// DOM element, array of elements, HTML string, or jQuery object to insert at the beginning of each element in the set of matched elements. 1502 | /// 1503 | /// 1504 | /// One or more additional DOM elements, array of elements, HTML strings, or jQuery objects to insert at the beginning of each element in the set of matched elements. 1505 | /// 1506 | /// 1507 | }, 1508 | appendTo: function(target){ 1509 | /// 1510 | /// Insert every element in the set of matched elements to the end of the target. 1511 | /// API Reference: http://api.jquery.com/appendTo 1512 | /// 1513 | /// 1514 | /// A selector, element, HTML string, or jQuery object; the matched set of elements will be inserted at the end of the element(s) specified by this parameter. 1515 | /// 1516 | /// 1517 | }, 1518 | append: function(content){ 1519 | /// 1520 | /// Insert content, specified by the parameter, to the end of each element in the set of matched elements. 1521 | /// Additional Signatures: 1522 | /// 1. .append( method ) 1523 | /// API Reference: http://api.jquery.com/append 1524 | /// 1525 | /// 1526 | /// An element, HTML string, or jQuery object to insert at the end of each element in the set of matched elements. 1527 | /// 1528 | /// 1529 | }, 1530 | val: function(){ 1531 | /// 1532 | /// Get the current value of the first element in the set of matched elements. 1533 | /// API Reference: http://api.jquery.com/val 1534 | /// 1535 | /// 1536 | }, 1537 | val: function(value){ 1538 | /// 1539 | /// Set the value of each element in the set of matched elements. 1540 | /// Additional Signatures: 1541 | /// 1. .val( method ) 1542 | /// API Reference: http://api.jquery.com/val 1543 | /// 1544 | /// 1545 | /// A string of text or an array of strings corresponding to the value of each matched element to set as selected/checked. 1546 | /// 1547 | /// 1548 | }, 1549 | text: function(){ 1550 | /// 1551 | /// Get the combined text contents of each element in the set of matched elements, including their descendants. 1552 | /// API Reference: http://api.jquery.com/text 1553 | /// 1554 | /// 1555 | }, 1556 | text: function(textString){ 1557 | /// 1558 | /// Set the content of each element in the set of matched elements to the specified text. 1559 | /// Additional Signatures: 1560 | /// 1. .text( method ) 1561 | /// API Reference: http://api.jquery.com/text 1562 | /// 1563 | /// 1564 | /// A string of text to set as the content of each matched element. 1565 | /// 1566 | /// 1567 | }, 1568 | html: function(){ 1569 | /// 1570 | /// Get the HTML contents of the first element in the set of matched elements. 1571 | /// API Reference: http://api.jquery.com/html 1572 | /// 1573 | /// 1574 | }, 1575 | html: function(htmlString){ 1576 | /// 1577 | /// Set the HTML contents of each element in the set of matched elements. 1578 | /// Additional Signatures: 1579 | /// 1. .html( method ) 1580 | /// API Reference: http://api.jquery.com/html 1581 | /// 1582 | /// 1583 | /// A string of HTML to set as the content of each matched element. 1584 | /// 1585 | /// 1586 | }, 1587 | map: function(method){ 1588 | /// 1589 | /// Pass each element in the current matched set through a function, producing a new jQuery object containing the return values. 1590 | /// API Reference: http://api.jquery.com/map 1591 | /// 1592 | /// 1593 | /// A function object that will be invoked for each element in the current set. 1594 | /// 1595 | /// 1596 | }, 1597 | is: function(selector){ 1598 | /// 1599 | /// Check the current matched set of elements against a selector and return true if at least one of these elements matches the selector. 1600 | /// API Reference: http://api.jquery.com/is 1601 | /// 1602 | /// 1603 | /// A string containing a selector expression to match elements against. 1604 | /// 1605 | /// 1606 | }, 1607 | eq: function(index){ 1608 | /// 1609 | /// Reduce the set of matched elements to the one at the specified index. 1610 | /// Additional Signatures: 1611 | /// 1. .eq( -index ) 1612 | /// API Reference: http://api.jquery.com/eq 1613 | /// 1614 | /// 1615 | /// An integer indicating the 0-based position of the element. 1616 | /// 1617 | /// 1618 | }, 1619 | filter: function(selector){ 1620 | /// 1621 | /// Reduce the set of matched elements to those that match the selector or pass the function's test. 1622 | /// Additional Signatures: 1623 | /// 1. .filter( method ) 1624 | /// 2. .filter( element ) 1625 | /// 3. .filter( jQuery object ) 1626 | /// API Reference: http://api.jquery.com/filter 1627 | /// 1628 | /// 1629 | /// A string containing a selector expression to match the current set of elements against. 1630 | /// 1631 | /// 1632 | }, 1633 | toggleClass: function(className){ 1634 | /// 1635 | /// Add or remove one or more classes from each element in the set of matched elements, depending on either the class's presence or the value of the switch argument. 1636 | /// Additional Signatures: 1637 | /// 1. .toggleClass( className, switch ) 1638 | /// 2. .toggleClass( method, [switch] ) 1639 | /// API Reference: http://api.jquery.com/toggleClass 1640 | /// 1641 | /// 1642 | /// One or more class names (separated by spaces) to be toggled for each element in the matched set. 1643 | /// 1644 | /// 1645 | }, 1646 | removeClass: function(className){ 1647 | /// 1648 | /// Remove a single class, multiple classes, or all classes from each element in the set of matched elements. 1649 | /// Additional Signatures: 1650 | /// 1. .removeClass( method ) 1651 | /// API Reference: http://api.jquery.com/removeClass 1652 | /// 1653 | /// 1654 | /// A class name to be removed from the class attribute of each matched element. 1655 | /// 1656 | /// 1657 | }, 1658 | hasClass: function(className){ 1659 | /// 1660 | /// Determine whether any of the matched elements are assigned the given class. 1661 | /// API Reference: http://api.jquery.com/hasClass 1662 | /// 1663 | /// 1664 | /// The class name to search for. 1665 | /// 1666 | /// 1667 | }, 1668 | removeAttr: function(attributeName){ 1669 | /// 1670 | /// Remove an attribute from each element in the set of matched elements. 1671 | /// API Reference: http://api.jquery.com/removeAttr 1672 | /// 1673 | /// 1674 | /// An attribute to remove. 1675 | /// 1676 | /// 1677 | }, 1678 | attr: function(attributeName){ 1679 | /// 1680 | /// Get the value of an attribute for the first element in the set of matched elements. 1681 | /// API Reference: http://api.jquery.com/attr 1682 | /// 1683 | /// 1684 | /// The name of the attribute to get. 1685 | /// 1686 | /// 1687 | }, 1688 | attr: function(attributeName, value){ 1689 | /// 1690 | /// Set one or more attributes for the set of matched elements. 1691 | /// Additional Signatures: 1692 | /// 1. .attr( map ) 1693 | /// 2. .attr( attributeName, method ) 1694 | /// API Reference: http://api.jquery.com/attr 1695 | /// 1696 | /// 1697 | /// The name of the attribute to set. 1698 | /// 1699 | /// 1700 | /// A value to set for the attribute. 1701 | /// 1702 | /// 1703 | }, 1704 | addClass: function(className){ 1705 | /// 1706 | /// Adds the specified class(es) to each of the set of matched elements. 1707 | /// Additional Signatures: 1708 | /// 1. .addClass( method ) 1709 | /// API Reference: http://api.jquery.com/addClass 1710 | /// 1711 | /// 1712 | /// One or more class names to be added to the class attribute of each matched element. 1713 | /// 1714 | /// 1715 | } 1716 | }; 1717 | 1718 | jQuery.subclass = function(){ 1719 | /// 1720 | /// Creates a subclass of the jQuery object, allowing you to add additional or altered jQuery methods and properties without affecting the global jQuery. 1721 | /// API Reference: http://api.jquery.com/jQuery.subclass 1722 | /// 1723 | /// 1724 | }; 1725 | jQuery.type = function(obj){ 1726 | /// 1727 | /// Determine the internal JavaScript [[Class]] of an object. 1728 | /// API Reference: http://api.jquery.com/jQuery.type 1729 | /// 1730 | /// 1731 | /// Object to get the internal JavaScript [[Class]] of. 1732 | /// 1733 | /// 1734 | }; 1735 | jQuery.isWindow = function(obj){ 1736 | /// 1737 | /// Determine whether the argument is a window. 1738 | /// API Reference: http://api.jquery.com/jQuery.isWindow 1739 | /// 1740 | /// 1741 | /// Object to test whether or not it is a window. 1742 | /// 1743 | /// 1744 | }; 1745 | jQuery.error = function(message){ 1746 | /// 1747 | /// Takes a string and throws an exception containing it. 1748 | /// API Reference: http://api.jquery.com/jQuery.error 1749 | /// 1750 | /// 1751 | /// The message to send out. 1752 | /// 1753 | }; 1754 | jQuery.parseJSON = function(json){ 1755 | /// 1756 | /// Takes a well-formed JSON string and returns the resulting JavaScript object. 1757 | /// API Reference: http://api.jquery.com/jQuery.parseJSON 1758 | /// 1759 | /// 1760 | /// The JSON string to parse. 1761 | /// 1762 | /// 1763 | }; 1764 | jQuery.proxy = function(method, context){ 1765 | /// 1766 | /// Takes a function and returns a new one that will always have a particular context. 1767 | /// Additional Signatures: 1768 | /// 1. jQuery.proxy( context, name ) 1769 | /// API Reference: http://api.jquery.com/jQuery.proxy 1770 | /// 1771 | /// 1772 | /// The function whose context will be changed. 1773 | /// 1774 | /// 1775 | /// The object to which the context (`this`) of the function should be set. 1776 | /// 1777 | /// 1778 | }; 1779 | jQuery.contains = function(container, contained){ 1780 | /// 1781 | /// Check to see if a DOM node is within another DOM node. 1782 | /// API Reference: http://api.jquery.com/jQuery.contains 1783 | /// 1784 | /// 1785 | /// The DOM element that may contain the other element. 1786 | /// 1787 | /// 1788 | /// The DOM node that may be contained by the other element. 1789 | /// 1790 | /// 1791 | }; 1792 | jQuery.noop = function(){ 1793 | /// 1794 | /// An empty function. 1795 | /// API Reference: http://api.jquery.com/jQuery.noop 1796 | /// 1797 | /// 1798 | }; 1799 | jQuery.globalEval = function(code){ 1800 | /// 1801 | /// Execute some JavaScript code globally. 1802 | /// API Reference: http://api.jquery.com/jQuery.globalEval 1803 | /// 1804 | /// 1805 | /// The JavaScript code to execute. 1806 | /// 1807 | }; 1808 | jQuery.isXMLDoc = function(node){ 1809 | /// 1810 | /// Check to see if a DOM node is within an XML document (or is an XML document). 1811 | /// API Reference: http://api.jquery.com/jQuery.isXMLDoc 1812 | /// 1813 | /// 1814 | /// The DOM node that will be checked to see if it's in an XML document. 1815 | /// 1816 | /// 1817 | }; 1818 | jQuery.removeData = function(element, name){ 1819 | /// 1820 | /// Remove a previously-stored piece of data. 1821 | /// API Reference: http://api.jquery.com/jQuery.removeData 1822 | /// 1823 | /// 1824 | /// A DOM element from which to remove data. 1825 | /// 1826 | /// 1827 | /// A string naming the piece of data to remove. 1828 | /// 1829 | /// 1830 | }; 1831 | jQuery.data = function(element, key, value){ 1832 | /// 1833 | /// Store arbitrary data associated with the specified element. 1834 | /// API Reference: http://api.jquery.com/jQuery.data 1835 | /// 1836 | /// 1837 | /// The DOM element to associate with the data. 1838 | /// 1839 | /// 1840 | /// A string naming the piece of data to set. 1841 | /// 1842 | /// 1843 | /// The new data value. 1844 | /// 1845 | /// 1846 | }; 1847 | jQuery.data = function(element, key){ 1848 | /// 1849 | /// Returns value at named data store for the element, as set by jQuery.data(element, name, value), or the full data store for the element. 1850 | /// Additional Signatures: 1851 | /// 1. jQuery.data( element ) 1852 | /// API Reference: http://api.jquery.com/jQuery.data 1853 | /// 1854 | /// 1855 | /// The DOM element to query for the data. 1856 | /// 1857 | /// 1858 | /// Name of the data stored. 1859 | /// 1860 | /// 1861 | }; 1862 | jQuery.dequeue = function(element, queueName){ 1863 | /// 1864 | /// Execute the next function on the queue for the matched element. 1865 | /// API Reference: http://api.jquery.com/jQuery.dequeue 1866 | /// 1867 | /// 1868 | /// A DOM element from which to remove and execute a queued function. 1869 | /// 1870 | /// 1871 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 1872 | /// 1873 | /// 1874 | }; 1875 | jQuery.queue = function(element, queueName){ 1876 | /// 1877 | /// Show the queue of functions to be executed on the matched element. 1878 | /// API Reference: http://api.jquery.com/jQuery.queue 1879 | /// 1880 | /// 1881 | /// A DOM element to inspect for an attached queue. 1882 | /// 1883 | /// 1884 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 1885 | /// 1886 | /// 1887 | }; 1888 | jQuery.queue = function(element, queueName, newQueue){ 1889 | /// 1890 | /// Manipulate the queue of functions to be executed on the matched element. 1891 | /// Additional Signatures: 1892 | /// 1. jQuery.queue( element, queueName, method ) 1893 | /// API Reference: http://api.jquery.com/jQuery.queue 1894 | /// 1895 | /// 1896 | /// A DOM element where the array of queued functions is attached. 1897 | /// 1898 | /// 1899 | /// A string containing the name of the queue. Defaults to fx, the standard effects queue. 1900 | /// 1901 | /// 1902 | /// An array of functions to replace the current queue contents. 1903 | /// 1904 | /// 1905 | }; 1906 | jQuery.isEmptyObject = function(object){ 1907 | /// 1908 | /// Check to see if an object is empty (contains no properties). 1909 | /// API Reference: http://api.jquery.com/jQuery.isEmptyObject 1910 | /// 1911 | /// 1912 | /// The object that will be checked to see if it's empty. 1913 | /// 1914 | /// 1915 | }; 1916 | jQuery.isPlainObject = function(object){ 1917 | /// 1918 | /// Check to see if an object is a plain object (created using "{}" or "new Object"). 1919 | /// API Reference: http://api.jquery.com/jQuery.isPlainObject 1920 | /// 1921 | /// 1922 | /// The object that will be checked to see if it's a plain object. 1923 | /// 1924 | /// 1925 | }; 1926 | jQuery.noConflict = function(removeAll){ 1927 | /// 1928 | /// Relinquish jQuery's control of the $ variable. 1929 | /// API Reference: http://api.jquery.com/jQuery.noConflict 1930 | /// 1931 | /// 1932 | /// A Boolean indicating whether to remove all jQuery variables from the global scope (including jQuery itself). 1933 | /// 1934 | /// 1935 | }; 1936 | jQuery.ajaxSetup = function(options){ 1937 | /// 1938 | /// Set default values for future Ajax requests. 1939 | /// API Reference: http://api.jquery.com/jQuery.ajaxSetup 1940 | /// 1941 | /// 1942 | /// A set of key/value pairs that configure the default Ajax request. All options are optional. 1943 | /// 1944 | }; 1945 | jQuery.post = function(url, data, method, dataType){ 1946 | /// 1947 | /// Load data from the server using a HTTP POST request. 1948 | /// API Reference: http://api.jquery.com/jQuery.post 1949 | /// 1950 | /// 1951 | /// A string containing the URL to which the request is sent. 1952 | /// 1953 | /// 1954 | /// A map or string that is sent to the server with the request. 1955 | /// 1956 | /// 1957 | /// A callback function that is executed if the request succeeds. 1958 | /// 1959 | /// 1960 | /// The type of data expected from the server. 1961 | /// 1962 | /// 1963 | }; 1964 | jQuery.getScript = function(url, method){ 1965 | /// 1966 | /// Load a JavaScript file from the server using a GET HTTP request, then execute it. 1967 | /// API Reference: http://api.jquery.com/jQuery.getScript 1968 | /// 1969 | /// 1970 | /// A string containing the URL to which the request is sent. 1971 | /// 1972 | /// 1973 | /// A callback function that is executed if the request succeeds. 1974 | /// 1975 | /// 1976 | }; 1977 | jQuery.getJSON = function(url, data, method){ 1978 | /// 1979 | /// Load JSON-encoded data from the server using a GET HTTP request. 1980 | /// API Reference: http://api.jquery.com/jQuery.getJSON 1981 | /// 1982 | /// 1983 | /// A string containing the URL to which the request is sent. 1984 | /// 1985 | /// 1986 | /// A map or string that is sent to the server with the request. 1987 | /// 1988 | /// 1989 | /// A callback function that is executed if the request succeeds. 1990 | /// 1991 | /// 1992 | }; 1993 | jQuery.get = function(url, data, method, dataType){ 1994 | /// 1995 | /// Load data from the server using a HTTP GET request. 1996 | /// API Reference: http://api.jquery.com/jQuery.get 1997 | /// 1998 | /// 1999 | /// A string containing the URL to which the request is sent. 2000 | /// 2001 | /// 2002 | /// A map or string that is sent to the server with the request. 2003 | /// 2004 | /// 2005 | /// A callback function that is executed if the request succeeds. 2006 | /// 2007 | /// 2008 | /// The type of data expected from the server. 2009 | /// 2010 | /// 2011 | }; 2012 | jQuery.ajax = function(settings){ 2013 | /// 2014 | /// Perform an asynchronous HTTP (Ajax) request. 2015 | /// API Reference: http://api.jquery.com/jQuery.ajax 2016 | /// 2017 | /// 2018 | /// A set of key/value pairs that configure the Ajax request. All options are optional. A default can be set for any option with $.ajaxSetup(). 2019 | /// 2020 | /// 2021 | }; 2022 | jQuery.param = function(obj){ 2023 | /// 2024 | /// Create a serialized representation of an array or object, suitable for use in a URL query string or Ajax request. 2025 | /// Additional Signatures: 2026 | /// 1. jQuery.param( obj, traditional ) 2027 | /// API Reference: http://api.jquery.com/jQuery.param 2028 | /// 2029 | /// 2030 | /// An array or object to serialize. 2031 | /// 2032 | /// 2033 | }; 2034 | jQuery.trim = function(str){ 2035 | /// 2036 | /// Remove the whitespace from the beginning and end of a string. 2037 | /// API Reference: http://api.jquery.com/jQuery.trim 2038 | /// 2039 | /// 2040 | /// The string to trim. 2041 | /// 2042 | /// 2043 | }; 2044 | jQuery.isFunction = function(obj){ 2045 | /// 2046 | /// Determine if the argument passed is a Javascript function object. 2047 | /// API Reference: http://api.jquery.com/jQuery.isFunction 2048 | /// 2049 | /// 2050 | /// Object to test whether or not it is a function. 2051 | /// 2052 | /// 2053 | }; 2054 | jQuery.isArray = function(obj){ 2055 | /// 2056 | /// Determine whether the argument is an array. 2057 | /// API Reference: http://api.jquery.com/jQuery.isArray 2058 | /// 2059 | /// 2060 | /// Object to test whether or not it is an array. 2061 | /// 2062 | /// 2063 | }; 2064 | jQuery.unique = function(array){ 2065 | /// 2066 | /// Sorts an array of DOM elements, in place, with the duplicates removed. Note that this only works on arrays of DOM elements, not strings or numbers. 2067 | /// API Reference: http://api.jquery.com/jQuery.unique 2068 | /// 2069 | /// 2070 | /// The Array of DOM elements. 2071 | /// 2072 | /// 2073 | }; 2074 | jQuery.merge = function(first, second){ 2075 | /// 2076 | /// Merge the contents of two arrays together into the first array. 2077 | /// API Reference: http://api.jquery.com/jQuery.merge 2078 | /// 2079 | /// 2080 | /// The first array to merge, the elements of second added. 2081 | /// 2082 | /// 2083 | /// The second array to merge into the first, unaltered. 2084 | /// 2085 | /// 2086 | }; 2087 | jQuery.inArray = function(value, array){ 2088 | /// 2089 | /// Search for a specified value within an array and return its index (or -1 if not found). 2090 | /// API Reference: http://api.jquery.com/jQuery.inArray 2091 | /// 2092 | /// 2093 | /// The value to search for. 2094 | /// 2095 | /// 2096 | /// An array through which to search. 2097 | /// 2098 | /// 2099 | }; 2100 | jQuery.map = function(array, method){ 2101 | /// 2102 | /// Translate all items in an array or array-like object to another array of items. 2103 | /// API Reference: http://api.jquery.com/jQuery.map 2104 | /// 2105 | /// 2106 | /// The Array to translate. 2107 | /// 2108 | /// 2109 | /// The function to process each item against. The first argument to the function is the list item, the second argument is the index in array The function can return any value. this will be the global window object. 2110 | /// 2111 | /// 2112 | }; 2113 | jQuery.makeArray = function(obj){ 2114 | /// 2115 | /// Convert an array-like object into a true JavaScript array. 2116 | /// API Reference: http://api.jquery.com/jQuery.makeArray 2117 | /// 2118 | /// 2119 | /// Any object to turn into a native Array. 2120 | /// 2121 | /// 2122 | }; 2123 | jQuery.grep = function(array, method, invert){ 2124 | /// 2125 | /// Finds the elements of an array which satisfy a filter function. The original array is not affected. 2126 | /// API Reference: http://api.jquery.com/jQuery.grep 2127 | /// 2128 | /// 2129 | /// The array to search through. 2130 | /// 2131 | /// 2132 | /// The function to process each item against. The first argument to the function is the item, and the second argument is the index. The function should return a Boolean value. this will be the global window object. 2133 | /// 2134 | /// 2135 | /// If "invert" is false, or not provided, then the function returns an array consisting of all elements for which "callback" returns true. If "invert" is true, then the function returns an array consisting of all elements for which "callback" returns false. 2136 | /// 2137 | /// 2138 | }; 2139 | jQuery.extend = function(target, object1, objectN){ 2140 | /// 2141 | /// Merge the contents of two or more objects together into the first object. 2142 | /// Additional Signatures: 2143 | /// 1. jQuery.extend( [deep], target, object1, [objectN] ) 2144 | /// API Reference: http://api.jquery.com/jQuery.extend 2145 | /// 2146 | /// 2147 | /// An object that will receive the new properties if additional objects are passed in or that will extend the jQuery namespace if it is the sole argument. 2148 | /// 2149 | /// 2150 | /// An object containing additional properties to merge in. 2151 | /// 2152 | /// 2153 | /// Additional objects containing properties to merge in. 2154 | /// 2155 | /// 2156 | }; 2157 | jQuery.each = function(collection, method){ 2158 | /// 2159 | /// A generic iterator function, which can be used to seamlessly iterate over both objects and arrays. Arrays and array-like objects with a length property (such as a function's arguments object) are iterated by numeric index, from 0 to length-1. Other objects are iterated via their named properties. 2160 | /// API Reference: http://api.jquery.com/jQuery.each 2161 | /// 2162 | /// 2163 | /// The object or array to iterate over. 2164 | /// 2165 | /// 2166 | /// The function that will be executed on every object. 2167 | /// 2168 | /// 2169 | }; -------------------------------------------------------------------------------- /mock site/js/test-vsdoc.js: -------------------------------------------------------------------------------- 1 | function doit(foo, bar){ 2 | /// 3 | /// Retrieve all the DOM elements contained in the jQuery set, as an array. 4 | /// API: .toArray() 5 | /// Categories: Miscellaneous > DOM Element Methods 6 | /// 7 | /// 8 | /// Access the element in the Nth position. 9 | /// 10 | /// 11 | /// An array of elements 12 | /// 13 | /// 14 | } 15 | 16 | 17 | function fart(){ 18 | /// 19 | /// asdasd\\nasdasd\\\naasdasd 20 | /// 21 | /// 22 | /// woo 23 | /// 24 | 25 | /// 26 | var HOLYCRAP; 27 | } 28 | 29 | 30 | MyEnumeration = function MyEnumeration() { 31 | /// Describes an enumeration 32 | /// 33 | /// describes a enumeration value 34 | /// 35 | /// 36 | /// describes a enumeration value 37 | /// 38 | }; 39 | 40 | -------------------------------------------------------------------------------- /mock site/js/test.js: -------------------------------------------------------------------------------- 1 |  2 | function doit(a, b){ 3 | console.log(a); 4 | console.log(b); 5 | } -------------------------------------------------------------------------------- /mock site/web.config: -------------------------------------------------------------------------------- 1 |  2 | 6 | 7 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /mock site/working.js: -------------------------------------------------------------------------------- 1 | /// 2 | /// 3 | 4 | 5 | $('div').delegate( 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | // http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx 34 | // http://www.scottlogic.co.uk/2010/08/vs-2010-vs-doc-and-javascript-intellisense/ 35 | // http://skysanders.net/subtext/archive/2010/02/22/visual-studio-javascript-intellisense-uncovered.aspx 36 | // http://skysanders.net/subtext/archive/2010/02/23/jquery-ajax-settings-object-for-vs-intellisense.aspx 37 | 38 | //Description 39 | 40 | //Description 52 | 53 | //Description 63 | 64 | //Description 75 | 76 | //The value tag describes a property (which shouldn't have a summary tag). 77 | 78 | //Description 89 | 90 | //The field tag (which doesn't exist in C# and VB.NET because in those languages the 91 | //summary tag can be used) is used inside of a class, interface or enumeration 92 | //constructor to describe a field. A field can't be described near the field 93 | //itself in JavaScript because the field itself doesn't have a body to contain 94 | //that description. --------------------------------------------------------------------------------