| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="fake library API docs, for the Dart programming language."> |
| <title>fake library - Dart API</title> |
| <!-- required because all the links are pseudo-absolute --> |
| <base href=".."> |
| |
| <link rel='stylesheet' href='https://fonts.googleapis.com/css?family=Source+Code+Pro|Roboto:500,400italic,300,400' type='text/css'> |
| <link rel="stylesheet" href="static-assets/prettify.css"> |
| <link rel="stylesheet" href="static-assets/css/bootstrap.min.css"> |
| <link rel="stylesheet" href="static-assets/styles.css"> |
| <link rel="icon" href="static-assets/favicon.png"> |
| |
| </head> |
| |
| <body> |
| |
| <div id="overlay-under-drawer"></div> |
| |
| <header class="container-fluid" id="title"> |
| <nav class="navbar navbar-fixed-top"> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-sm-12 contents"> |
| <button id="sidenav-left-toggle" type="button"> </button> |
| <ol class="breadcrumbs gt-separated hidden-xs"> |
| <li><a href="index.html">test_package</a></li> |
| <li class="self-crumb">fake</li> |
| </ol> |
| <div class="self-name">fake</div> |
| <form class="search navbar-right" role="search"> |
| <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search..."> |
| </form> |
| </div> <!-- /col --> |
| </div> <!-- /row --> |
| </div> <!-- /container --> |
| </nav> |
| |
| <div class="container masthead"> |
| <div class="row"> |
| <div class="col-sm-12 contents"> |
| <ol class="breadcrumbs gt-separated visible-xs"> |
| <li><a href="index.html">test_package</a></li> |
| <li class="self-crumb">fake</li> |
| </ol> |
| <div class="title-description"> |
| <h1 class="title"> |
| <span class="kind">library</span> fake |
| </h1> |
| </div> |
| <ul class="subnav"> |
| <li><a href="fake/fake-library.html#classes">Classes</a></li> |
| <li><a href="fake/fake-library.html#constants">Constants</a></li> |
| <li><a href="fake/fake-library.html#properties">Properties</a></li> |
| <li><a href="fake/fake-library.html#functions">Functions</a></li> |
| <li><a href="fake/fake-library.html#enums">Enums</a></li> |
| <li><a href="fake/fake-library.html#typedefs">Typedefs</a></li> |
| <li><a href="fake/fake-library.html#exceptions">Exceptions</a></li> |
| </ul> |
| </div> <!-- /col --> |
| </div> <!-- /row --> |
| </div> <!-- /container --> |
| |
| </header> |
| |
| <div class="container body"> |
| <div class="row"> |
| |
| <div class="col-xs-6 col-sm-3 col-md-2 sidebar sidebar-offcanvas-left"> |
| <h5><a href="index.html">test_package</a></h5> |
| |
| |
| <ol> |
| <li class="section-title"><a href="index.html#libraries">Libraries</a></li> |
| <li><a href="anonymous_library/anonymous_library-library.html">anonymous_library</a></li> |
| <li><a href="another_anonymous_lib/another_anonymous_lib-library.html">another_anonymous_lib</a></li> |
| <li><a href="code_in_comments/code_in_comments-library.html">code_in_comments</a></li> |
| <li><a href="css/css-library.html">css</a></li> |
| <li><a href="ex/ex-library.html">ex</a></li> |
| <li><a href="fake/fake-library.html">fake</a></li> |
| <li><a class="deprecated" href="is_deprecated/is_deprecated-library.html">is_deprecated</a></li> |
| <li><a href="test_package_imported.main/test_package_imported.main-library.html">test_package_imported.main</a></li> |
| <li><a href="two_exports/two_exports-library.html">two_exports</a></li> |
| </ol> |
| </div> |
| |
| <div class="col-xs-12 col-sm-9 col-md-8 main-content"> |
| |
| <section class="desc markdown"> |
| <h1>WOW FAKE PACKAGE IS <strong>BEST</strong> <a href="http://example.org">PACKAGE</a></h1> |
| <p>If you don't have this package yet, get it. |
| Don't ask questions.</p> |
| <p>Testing code <code>true</code> and <code>false</code></p> |
| <p>Testing string escaping: <code>var s = 'I am a string'</code></p> |
| <p>My favorite class is <a href="fake/Cool-class.html">Cool</a>.</p> |
| <h2>I am an h2</h2> |
| <p>hello there</p> |
| <h3>I am an h3</h3> |
| <p>hello there</p> |
| <h4>I am an h4</h4> |
| <p>hello there</p> |
| <h5>I am an h5</h5> |
| <p>hello</p> |
| <p><em>Why should you get this package?</em></p><ul><li>We told you so.</li><li>Everyone is doing it.</li><li>It smells nice.</li></ul> |
| <pre class="prettyprint language-dart"><code>class Foo { |
| long line is very long long line is very long long line is very long line long line long line |
| } |
| </code></pre> |
| <p>Here are some hyperlinks with angle brackets:</p><ul><li><a href="https://myfakepackage.com/withapath">myfakepackage.com/withapath</a></li><li><a href="ftp://ftp.myfakepackage.com/donthidemyschema">ftp://ftp.myfakepackage.com/donthidemyschema</a></li><li><a href="http://myfakepackage.com/buthidethisone">myfakepackage.com/buthidethisone</a></li></ul> |
| </section> |
| |
| <section class="summary offset-anchor" id="classes"> |
| <h2>Classes</h2> |
| |
| <dl> |
| <dt id="Annotation"> |
| <span class="name "><a href="fake/Annotation-class.html">Annotation</a></span> |
| </dt> |
| <dd> |
| <p>Useful for annotations.</p> |
| </dd> |
| <dt id="AnotherInterface"> |
| <span class="name "><a href="fake/AnotherInterface-class.html">AnotherInterface</a></span> |
| </dt> |
| <dd> |
| <p>Yet another interface that can be implemented.</p> |
| </dd> |
| <dt id="BaseForDocComments"> |
| <span class="name "><a href="fake/BaseForDocComments-class.html">BaseForDocComments</a></span> |
| </dt> |
| <dd> |
| <p></p> |
| </dd> |
| <dt id="ClassWithUnusualProperties"> |
| <span class="name "><a href="fake/ClassWithUnusualProperties-class.html">ClassWithUnusualProperties</a></span> |
| </dt> |
| <dd> |
| <p>Classes with unusual properties? I don't think they exist.</p> |
| </dd> |
| <dt id="ConstantClass"> |
| <span class="name "><a href="fake/ConstantClass-class.html">ConstantClass</a></span> |
| </dt> |
| <dd> |
| <p>For make-better testing of constants.</p> |
| </dd> |
| <dt id="Cool"> |
| <span class="name "><a href="fake/Cool-class.html">Cool</a></span> |
| </dt> |
| <dd> |
| <p>This class is cool!</p> |
| </dd> |
| <dt id="ExtraSpecialList"> |
| <span class="name "><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></span> |
| </dt> |
| <dd> |
| <p>This inherits operators.</p> |
| </dd> |
| <dt id="Foo2"> |
| <span class="name "><a href="fake/Foo2-class.html">Foo2</a></span> |
| </dt> |
| <dd> |
| <p>link to method from class <a href="ex/Apple/m.html">Apple.m</a></p> |
| </dd> |
| <dt id="HasGenerics"> |
| <span class="name "><a href="fake/HasGenerics-class.html">HasGenerics</a></span> |
| </dt> |
| <dd> |
| <p></p> |
| </dd> |
| <dt id="HasGenericWithExtends"> |
| <span class="name "><a href="fake/HasGenericWithExtends-class.html">HasGenericWithExtends</a></span> |
| </dt> |
| <dd> |
| <p>I have a generic and it extends <a href="fake/Foo2-class.html">Foo2</a></p> |
| </dd> |
| <dt id="ImplicitProperties"> |
| <span class="name "><a href="fake/ImplicitProperties-class.html">ImplicitProperties</a></span> |
| </dt> |
| <dd> |
| <p>Names are actually wrong in this class, but when we extend it, |
| they are correct.</p> |
| </dd> |
| <dt id="Interface"> |
| <span class="name "><a href="fake/Interface-class.html">Interface</a></span> |
| </dt> |
| <dd> |
| <p>An interface that can be implemented.</p> |
| </dd> |
| <dt id="LongFirstLine"> |
| <span class="name "><a href="fake/LongFirstLine-class.html">LongFirstLine</a></span> |
| </dt> |
| <dd> |
| <p>This is a very long line spread |
| across... wait for it... two physical lines.</p> |
| </dd> |
| <dt id="MixMeIn"> |
| <span class="name "><a href="fake/MixMeIn-class.html">MixMeIn</a></span> |
| </dt> |
| <dd> |
| <p>Perfect for mix-ins.</p> |
| </dd> |
| <dt id="OperatorReferenceClass"> |
| <span class="name "><a href="fake/OperatorReferenceClass-class.html">OperatorReferenceClass</a></span> |
| </dt> |
| <dd> |
| <p>Test operator references: <a href="fake/OperatorReferenceClass/operator_equals.html">OperatorReferenceClass.==</a>.</p> |
| </dd> |
| <dt id="OtherGenericsThing"> |
| <span class="name "><a href="fake/OtherGenericsThing-class.html">OtherGenericsThing</a></span> |
| </dt> |
| <dd> |
| <p></p> |
| </dd> |
| <dt id="SpecialList"> |
| <span class="name "><a href="fake/SpecialList-class.html">SpecialList</a></span> |
| </dt> |
| <dd> |
| <p>Extends <code>ListBase</code></p> |
| </dd> |
| <dt id="SubForDocComments"> |
| <span class="name "><a href="fake/SubForDocComments-class.html">SubForDocComments</a></span> |
| </dt> |
| <dd> |
| <p>Testing if docs for inherited method are correct.</p> |
| </dd> |
| <dt id="SuperAwesomeClass"> |
| <span class="name deprecated"><a class="deprecated" href="fake/SuperAwesomeClass-class.html">SuperAwesomeClass</a></span> |
| </dt> |
| <dd> |
| <p>A super class, with many powers. Link to <a href="ex/Apple-class.html">Apple</a> from another library.</p> |
| </dd> |
| <dt id="WithGetterAndSetter"> |
| <span class="name "><a href="fake/WithGetterAndSetter-class.html">WithGetterAndSetter</a></span> |
| </dt> |
| <dd> |
| <p>Tests a single field with explict getter and setter.</p> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="constants"> |
| <h2>Constants</h2> |
| |
| <dl class="properties"> |
| <dt id="CUSTOM_CLASS" class="constant"> |
| <span class="name "><a href="fake/CUSTOM_CLASS-constant.html">CUSTOM_CLASS</a></span> |
| <span class="signature">→ <a href="fake/ConstantClass-class.html">ConstantClass</a></span> |
| </dt> |
| <dd> |
| <p></p> |
| |
| <div> |
| <span class="signature"><code>const <a href="fake/ConstantClass-class.html">ConstantClass</a>('custom')</code></span> |
| </div> |
| </dd> |
| <dt id="DOWN" class="constant"> |
| <span class="name deprecated"><a class="deprecated" href="fake/DOWN-constant.html">DOWN</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| <p>Dynamic-typed down.</p> |
| |
| <div> |
| <span class="signature"><code>'down'</code></span> |
| </div> |
| </dd> |
| <dt id="greatAnnotation" class="constant"> |
| <span class="name "><a href="fake/greatAnnotation-constant.html">greatAnnotation</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| <p>This is a great thing.</p> |
| |
| <div> |
| <span class="signature"><code>'great'</code></span> |
| </div> |
| </dd> |
| <dt id="greatestAnnotation" class="constant"> |
| <span class="name "><a href="fake/greatestAnnotation-constant.html">greatestAnnotation</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| <p>This is the greatest thing.</p> |
| |
| <div> |
| <span class="signature"><code>'greatest'</code></span> |
| </div> |
| </dd> |
| <dt id="incorrectDocReference" class="constant"> |
| <span class="name "><a href="fake/incorrectDocReference-constant.html">incorrectDocReference</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| <p>Referencing something that <code>doesn't exist</code>.</p> |
| |
| <div> |
| <span class="signature"><code>'doh'</code></span> |
| </div> |
| </dd> |
| <dt id="NAME_SINGLEUNDERSCORE" class="constant"> |
| <span class="name "><a href="fake/NAME_SINGLEUNDERSCORE-constant.html">NAME_SINGLEUNDERSCORE</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| <p></p> |
| |
| <div> |
| <span class="signature"><code>'yay bug hunting'</code></span> |
| </div> |
| </dd> |
| <dt id="NAME_WITH_TWO_UNDERSCORES" class="constant"> |
| <span class="name "><a href="fake/NAME_WITH_TWO_UNDERSCORES-constant.html">NAME_WITH_TWO_UNDERSCORES</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| <p></p> |
| |
| <div> |
| <span class="signature"><code>'episode seven better be good; episode seven better be good; episode seven better be good; episode seven better be good'</code></span> |
| </div> |
| </dd> |
| <dt id="PI" class="constant"> |
| <span class="name "><a href="fake/PI-constant.html">PI</a></span> |
| <span class="signature">→ double</span> |
| </dt> |
| <dd> |
| <p>Constant property.</p> |
| |
| <div> |
| <span class="signature"><code>3.14159</code></span> |
| </div> |
| </dd> |
| <dt id="required" class="constant"> |
| <span class="name "><a href="fake/required-constant.html">required</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| <p></p> |
| |
| <div> |
| <span class="signature"><code>'required'</code></span> |
| </div> |
| </dd> |
| <dt id="testingCodeSyntaxInOneLiners" class="constant"> |
| <span class="name "><a href="fake/testingCodeSyntaxInOneLiners-constant.html">testingCodeSyntaxInOneLiners</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| <p>These are code syntaxes: <code>true</code> and <code>false</code></p> |
| |
| <div> |
| <span class="signature"><code>'fantastic'</code></span> |
| </div> |
| </dd> |
| <dt id="UP" class="constant"> |
| <span class="name "><a href="fake/UP-constant.html">UP</a></span> |
| <span class="signature">→ String</span> |
| </dt> |
| <dd> |
| <p>Up is a direction.</p> |
| |
| <div> |
| <span class="signature"><code>'up'</code></span> |
| </div> |
| </dd> |
| <dt id="ZERO" class="constant"> |
| <span class="name "><a href="fake/ZERO-constant.html">ZERO</a></span> |
| <span class="signature">→ int</span> |
| </dt> |
| <dd> |
| <p>A constant integer value, |
| which is a bit redundant.</p> |
| |
| <div> |
| <span class="signature"><code>0</code></span> |
| </div> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="properties"> |
| <h2>Properties</h2> |
| |
| <dl class="properties"> |
| <dt id="dynamicGetter" class="property"> |
| <span class="name"><a href="fake/dynamicGetter.html">dynamicGetter</a></span> |
| <span class="signature">→ dynamic</span> |
| </dt> |
| <dd> |
| <p>A dynamic getter.</p> |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="justGetter" class="property"> |
| <span class="name"><a href="fake/justGetter.html">justGetter</a></span> |
| <span class="signature">→ bool</span> |
| </dt> |
| <dd> |
| <p>Just a getter. No partner setter.</p> |
| <div class="features">read-only</div> |
| </dd> |
| <dt id="justSetter" class="property"> |
| <span class="name"><a href="fake/justSetter.html">justSetter</a></span><span class="signature"> |
| <span class="returntype parameter">← <span class="parameter" id="justSetter=-param-value"><span class="type-annotation">int</span> <span class="parameter-name">value</span></span> </span> |
| </span> |
| </dt> |
| <dd> |
| <p>Just a setter. No partner getter.</p> |
| <div class="features">write-only</div> |
| </dd> |
| <dt id="mapWithDynamicKeys" class="property"> |
| <span class="name"><a href="fake/mapWithDynamicKeys.html">mapWithDynamicKeys</a></span><span class="signature"> |
| <span class="returntype parameter">↔ <span class="parameter" id="mapWithDynamicKeys=-param-_mapWithDynamicKeys"><span class="type-annotation">Map<dynamic, String></span> </span> </span> |
| </span> |
| </dt> |
| <dd> |
| <p></p> |
| <div class="features">read / write</div> |
| </dd> |
| <dt id="meaningOfLife" class="property"> |
| <span class="name"><a class="deprecated" href="fake/meaningOfLife.html">meaningOfLife</a></span> |
| <span class="signature">→ int</span> |
| </dt> |
| <dd> |
| <p>Final property.</p> |
| <div class="features">final</div> |
| </dd> |
| <dt id="setAndGet" class="property"> |
| <span class="name"><a href="fake/setAndGet.html">setAndGet</a></span><span class="signature"> |
| <span class="returntype parameter">↔ <span class="parameter" id="setAndGet=-param-thing"><span class="type-annotation">String</span> <span class="parameter-name">thing</span></span> </span> |
| </span> |
| </dt> |
| <dd> |
| <p>The getter for setAndGet.</p> |
| <div class="features">read / write</div> |
| </dd> |
| <dt id="simpleProperty" class="property"> |
| <span class="name"><a href="fake/simpleProperty.html">simpleProperty</a></span><span class="signature"> |
| <span class="returntype parameter">↔ <span class="parameter" id="simpleProperty=-param-_simpleProperty"><span class="type-annotation">String</span> </span> </span> |
| </span> |
| </dt> |
| <dd> |
| <p>Simple property</p> |
| <div class="features">read / write</div> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="functions"> |
| <h2>Functions</h2> |
| |
| <dl class="callables"> |
| <dt id="addCallback" class="callable"> |
| <span class="name"><a href="fake/addCallback.html">addCallback</a></span><span class="signature">(<wbr><span class="parameter" id="addCallback-param-callback"><span class="type-annotation"><a href="fake/VoidCallback.html">VoidCallback</a></span> <span class="parameter-name">callback</span></span>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Adds a callback.</p> |
| |
| </dd> |
| <dt id="addCallback2" class="callable"> |
| <span class="name"><a href="fake/addCallback2.html">addCallback2</a></span><span class="signature">(<wbr><span class="parameter" id="addCallback2-param-callback"><span class="type-annotation"><a href="fake/Callback2.html">Callback2</a></span> <span class="parameter-name">callback</span></span>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Adds another callback.</p> |
| |
| </dd> |
| <dt id="functionWithFunctionParameters" class="callable"> |
| <span class="name"><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></span><span class="signature">(<wbr><span class="parameter" id="functionWithFunctionParameters-param-number"><span class="type-annotation">int</span> <span class="parameter-name">number</span>, </span> <span class="parameter" id="functionWithFunctionParameters-param-thing"><span class="type-annotation">void</span> <span class="parameter-name">thing</span>(<span class="parameter" id="thing-param-one"><span class="parameter-name">one</span>, </span> <span class="parameter" id="thing-param-two"><span class="parameter-name">two</span></span>), </span> <span class="parameter" id="functionWithFunctionParameters-param-string"><span class="type-annotation">String</span> <span class="parameter-name">string</span>, </span> <span class="parameter" id="functionWithFunctionParameters-param-asyncThing"><span class="type-annotation">Future</span> <span class="parameter-name">asyncThing</span>(<span class="parameter" id="asyncThing-param-three"><span class="parameter-name">three</span>, </span> <span class="parameter" id="asyncThing-param-four"><span class="parameter-name">four</span>, </span> <span class="parameter" id="asyncThing-param-five"><span class="parameter-name">five</span>, </span> <span class="parameter" id="asyncThing-param-six"><span class="parameter-name">six</span>, </span> <span class="parameter" id="asyncThing-param-seven"><span class="parameter-name">seven</span></span>)</span>) |
| <span class="returntype parameter">→ String</span> |
| </span> |
| </dt> |
| <dd> |
| <p>This function has two parameters that are functions.</p> |
| |
| </dd> |
| <dt id="onlyPositionalWithNoDefaultNoType" class="callable"> |
| <span class="name"><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></span><span class="signature">(<wbr>[<span class="parameter" id="onlyPositionalWithNoDefaultNoType-param-anything"><span class="parameter-name">anything</span></span> ]) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p>A single optional positional param, no type annotation, no default value.</p> |
| <div class="features">@greatAnnotation</div> |
| </dd> |
| <dt id="paintImage1" class="callable"> |
| <span class="name"><a href="fake/paintImage1.html">paintImage1</a></span><span class="signature">(<wbr>{<span class="parameter" id="paintImage1-param-canvas"><span class="type-annotation">String</span> <span class="parameter-name">canvas</span>, </span> <span class="parameter" id="paintImage1-param-rect"><span class="type-annotation">int</span> <span class="parameter-name">rect</span>, </span> <span class="parameter" id="paintImage1-param-image"><span class="type-annotation"><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></span> <span class="parameter-name">image</span>, </span> <span class="parameter" id="paintImage1-param-colorFilter"><span class="type-annotation"><a href="fake/BaseForDocComments-class.html">BaseForDocComments</a></span> <span class="parameter-name">colorFilter</span>, </span> <span class="parameter" id="paintImage1-param-repeat"><span class="type-annotation">String</span> <span class="parameter-name">repeat</span>: <span class="default-value">LongFirstLine.THING</span></span> }) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Paints an image into the given rectangle in the canvas.</p> |
| |
| </dd> |
| <dt id="paintImage2" class="callable"> |
| <span class="name"><a href="fake/paintImage2.html">paintImage2</a></span><span class="signature">(<wbr><span class="parameter" id="paintImage2-param-fooParam"><span class="type-annotation">String</span> <span class="parameter-name">fooParam</span>, [</span> <span class="parameter" id="paintImage2-param-canvas"><span class="type-annotation">String</span> <span class="parameter-name">canvas</span>, </span> <span class="parameter" id="paintImage2-param-rect"><span class="type-annotation">int</span> <span class="parameter-name">rect</span>, </span> <span class="parameter" id="paintImage2-param-image"><span class="type-annotation"><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></span> <span class="parameter-name">image</span>, </span> <span class="parameter" id="paintImage2-param-colorFilter"><span class="type-annotation"><a href="fake/BaseForDocComments-class.html">BaseForDocComments</a></span> <span class="parameter-name">colorFilter</span>, </span> <span class="parameter" id="paintImage2-param-repeat"><span class="type-annotation">String</span> <span class="parameter-name">repeat</span> = <span class="default-value">LongFirstLine.THING</span></span> ]) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Paints an image into the given rectangle in the canvas.</p> |
| |
| </dd> |
| <dt id="paramFromAnotherLib" class="callable"> |
| <span class="name"><a href="fake/paramFromAnotherLib.html">paramFromAnotherLib</a></span><span class="signature">(<wbr><span class="parameter" id="paramFromAnotherLib-param-thing"><span class="type-annotation"><a href="ex/Apple-class.html">Apple</a></span> <span class="parameter-name">thing</span></span>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p><code>FooBar</code> comes from another library.</p> |
| |
| </dd> |
| <dt id="short" class="callable"> |
| <span class="name"><a href="fake/short.html">short</a></span><span class="signature">(<wbr>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Testing <a href="fake/NAME_WITH_TWO_UNDERSCORES-constant.html">NAME_WITH_TWO_UNDERSCORES</a> should not be italicized.</p> |
| |
| </dd> |
| <dt id="soIntense" class="callable"> |
| <span class="name"><a href="fake/soIntense.html">soIntense</a></span><span class="signature">(<wbr><span class="parameter" id="soIntense-param-anything"><span class="parameter-name">anything</span>, {</span> <span class="parameter" id="soIntense-param-flag"><span class="type-annotation">bool</span> <span class="parameter-name">flag</span>: <span class="default-value">true</span>, </span> <span class="parameter" id="soIntense-param-value"><span class="type-annotation">int</span> <span class="parameter-name">value</span></span> }) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Top-level function with 1 param and 2 optional named params, 1 with a |
| default value.</p> |
| |
| </dd> |
| <dt id="thisIsAlsoAsync" class="callable"> |
| <span class="name"><a href="fake/thisIsAlsoAsync.html">thisIsAlsoAsync</a></span><span class="signature">(<wbr>) |
| <span class="returntype parameter">→ Future</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Explicitly returns a Future and is marked async.</p> |
| |
| </dd> |
| <dt id="thisIsAsync" class="callable"> |
| <span class="name"><a href="fake/thisIsAsync.html">thisIsAsync</a></span><span class="signature">(<wbr>) |
| <span class="returntype parameter">→ Future</span> |
| </span> |
| </dt> |
| <dd> |
| <p>An async function. It should look like I return a <code>Future</code>.</p> |
| |
| </dd> |
| <dt id="topLevelFunction" class="callable"> |
| <span class="name deprecated"><a class="deprecated" href="fake/topLevelFunction.html">topLevelFunction</a></span><span class="signature">(<wbr><span class="parameter" id="topLevelFunction-param-param1"><span class="type-annotation">int</span> <span class="parameter-name">param1</span>, </span> <span class="parameter" id="topLevelFunction-param-param2"><span class="type-annotation">bool</span> <span class="parameter-name">param2</span>, </span> <span class="parameter" id="topLevelFunction-param-coolBeans"><span class="type-annotation"><a href="fake/Cool-class.html">Cool</a></span> <span class="parameter-name">coolBeans</span>, [</span> <span class="parameter" id="topLevelFunction-param-optionalPositional"><span class="type-annotation">double</span> <span class="parameter-name">optionalPositional</span> = <span class="default-value">0.0</span></span> ]) |
| <span class="returntype parameter">→ String</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Top-level function 3 params and 1 optional positional param.</p> |
| |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="enums"> |
| <h2>Enums</h2> |
| |
| <dl> |
| <dt id="Color"> |
| <a href="fake/Color-class.html">Color</a> |
| </dt> |
| <dd> |
| <p>An <code>enum</code> for ROYGBIV constants.</p> |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="typedefs"> |
| <h2>Typedefs</h2> |
| |
| <dl class="callables"> |
| <dt id="Callback2" class="callable"> |
| <span class="name"><a href="fake/Callback2.html">Callback2</a></span><span class="signature">(<wbr><span class="parameter" id="Callback2-param-String"><span class="parameter-name">String</span></span>) |
| <span class="returntype parameter">→ int</span> |
| </span> |
| </dt> |
| <dd> |
| <p></p> |
| |
| </dd> |
| <dt id="FakeProcesses" class="callable"> |
| <span class="name deprecated"><a class="deprecated" href="fake/FakeProcesses.html">FakeProcesses</a></span><span class="signature">(<wbr><span class="parameter" id="FakeProcesses-param-input"><span class="type-annotation">String</span> <span class="parameter-name">input</span></span>) |
| <span class="returntype parameter">→ String</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Takes input, returns output.</p> |
| |
| </dd> |
| <dt id="GenericTypedef" class="callable"> |
| <span class="name"><a href="fake/GenericTypedef.html">GenericTypedef</a></span><span class="signature">(<wbr><span class="parameter" id="GenericTypedef-param-input"><span class="type-annotation">T</span> <span class="parameter-name">input</span></span>) |
| <span class="returntype parameter">→ T</span> |
| </span> |
| </dt> |
| <dd> |
| <p>A typedef with a type parameter.</p> |
| |
| </dd> |
| <dt id="LotsAndLotsOfParameters" class="callable"> |
| <span class="name"><a href="fake/LotsAndLotsOfParameters.html">LotsAndLotsOfParameters</a></span><span class="signature">(<wbr><span class="parameter" id="LotsAndLotsOfParameters-param-so"><span class="parameter-name">so</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-many"><span class="parameter-name">many</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-parameters"><span class="parameter-name">parameters</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-it"><span class="parameter-name">it</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-should"><span class="parameter-name">should</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-wrap"><span class="parameter-name">wrap</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-when"><span class="parameter-name">when</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-converted"><span class="parameter-name">converted</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-to"><span class="parameter-name">to</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-html"><span class="parameter-name">html</span>, </span> <span class="parameter" id="LotsAndLotsOfParameters-param-documentation"><span class="parameter-name">documentation</span></span>) |
| <span class="returntype parameter">→ int</span> |
| </span> |
| </dt> |
| <dd> |
| <p>Lots and lots of parameters.</p> |
| |
| </dd> |
| <dt id="myCoolTypedef" class="callable"> |
| <span class="name"><a href="fake/myCoolTypedef.html">myCoolTypedef</a></span><span class="signature">(<wbr><span class="parameter" id="myCoolTypedef-param-x"><span class="type-annotation"><a href="fake/Cool-class.html">Cool</a></span> <span class="parameter-name">x</span>, </span> <span class="parameter" id="myCoolTypedef-param-y"><span class="type-annotation">bool</span> <span class="parameter-name">y</span></span>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p></p> |
| |
| </dd> |
| <dt id="VoidCallback" class="callable"> |
| <span class="name"><a href="fake/VoidCallback.html">VoidCallback</a></span><span class="signature">(<wbr>) |
| <span class="returntype parameter">→ void</span> |
| </span> |
| </dt> |
| <dd> |
| <p></p> |
| |
| </dd> |
| </dl> |
| </section> |
| |
| <section class="summary offset-anchor" id="exceptions"> |
| <h2>Exceptions / Errors</h2> |
| |
| <dl> |
| <dt id="Doh"> |
| <span class="name deprecated"><a class="deprecated" href="fake/Doh-class.html">Doh</a></span> |
| </dt> |
| <dd> |
| <p>Also, my bad.</p> |
| </dd> |
| <dt id="Oops"> |
| <span class="name "><a href="fake/Oops-class.html">Oops</a></span> |
| </dt> |
| <dd> |
| <p>My bad!</p> |
| </dd> |
| </dl> |
| </section> |
| |
| </div> <!-- /.main-content --> |
| |
| <div class="col-xs-6 col-sm-6 col-md-2 sidebar sidebar-offcanvas-right"> |
| <h5>fake</h5> |
| <ol> |
| <li class="section-title"><a href="fake/fake-library.html#classes">Classes</a></li> |
| <li><a href="fake/Annotation-class.html">Annotation</a></li> |
| <li><a href="fake/AnotherInterface-class.html">AnotherInterface</a></li> |
| <li><a href="fake/BaseForDocComments-class.html">BaseForDocComments</a></li> |
| <li><a href="fake/ClassWithUnusualProperties-class.html">ClassWithUnusualProperties</a></li> |
| <li><a href="fake/ConstantClass-class.html">ConstantClass</a></li> |
| <li><a href="fake/Cool-class.html">Cool</a></li> |
| <li><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></li> |
| <li><a href="fake/Foo2-class.html">Foo2</a></li> |
| <li><a href="fake/HasGenerics-class.html">HasGenerics</a></li> |
| <li><a href="fake/HasGenericWithExtends-class.html">HasGenericWithExtends</a></li> |
| <li><a href="fake/ImplicitProperties-class.html">ImplicitProperties</a></li> |
| <li><a href="fake/Interface-class.html">Interface</a></li> |
| <li><a href="fake/LongFirstLine-class.html">LongFirstLine</a></li> |
| <li><a href="fake/MixMeIn-class.html">MixMeIn</a></li> |
| <li><a href="fake/OperatorReferenceClass-class.html">OperatorReferenceClass</a></li> |
| <li><a href="fake/OtherGenericsThing-class.html">OtherGenericsThing</a></li> |
| <li><a href="fake/SpecialList-class.html">SpecialList</a></li> |
| <li><a href="fake/SubForDocComments-class.html">SubForDocComments</a></li> |
| <li><a class="deprecated" href="fake/SuperAwesomeClass-class.html">SuperAwesomeClass</a></li> |
| <li><a href="fake/WithGetterAndSetter-class.html">WithGetterAndSetter</a></li> |
| |
| <li class="section-title"><a href="fake/fake-library.html#constants">Constants</a></li> |
| <li><a href="fake/CUSTOM_CLASS-constant.html">CUSTOM_CLASS</a></li> |
| <li><a class="deprecated" href="fake/DOWN-constant.html">DOWN</a></li> |
| <li><a href="fake/greatAnnotation-constant.html">greatAnnotation</a></li> |
| <li><a href="fake/greatestAnnotation-constant.html">greatestAnnotation</a></li> |
| <li><a href="fake/incorrectDocReference-constant.html">incorrectDocReference</a></li> |
| <li><a href="fake/NAME_SINGLEUNDERSCORE-constant.html">NAME_SINGLEUNDERSCORE</a></li> |
| <li><a href="fake/NAME_WITH_TWO_UNDERSCORES-constant.html">NAME_WITH_TWO_UNDERSCORES</a></li> |
| <li><a href="fake/PI-constant.html">PI</a></li> |
| <li><a href="fake/required-constant.html">required</a></li> |
| <li><a href="fake/testingCodeSyntaxInOneLiners-constant.html">testingCodeSyntaxInOneLiners</a></li> |
| <li><a href="fake/UP-constant.html">UP</a></li> |
| <li><a href="fake/ZERO-constant.html">ZERO</a></li> |
| |
| <li class="section-title"><a href="fake/fake-library.html#properties">Properties</a></li> |
| <li><a href="fake/dynamicGetter.html">dynamicGetter</a></li> |
| <li><a href="fake/justGetter.html">justGetter</a></li> |
| <li><a href="fake/justSetter.html">justSetter</a></li> |
| <li><a href="fake/mapWithDynamicKeys.html">mapWithDynamicKeys</a></li> |
| <li><a class="deprecated" href="fake/meaningOfLife.html">meaningOfLife</a></li> |
| <li><a href="fake/setAndGet.html">setAndGet</a></li> |
| <li><a href="fake/simpleProperty.html">simpleProperty</a></li> |
| |
| <li class="section-title"><a href="fake/fake-library.html#functions">Functions</a></li> |
| <li><a href="fake/addCallback.html">addCallback</a></li> |
| <li><a href="fake/addCallback2.html">addCallback2</a></li> |
| <li><a href="fake/functionWithFunctionParameters.html">functionWithFunctionParameters</a></li> |
| <li><a href="fake/onlyPositionalWithNoDefaultNoType.html">onlyPositionalWithNoDefaultNoType</a></li> |
| <li><a href="fake/paintImage1.html">paintImage1</a></li> |
| <li><a href="fake/paintImage2.html">paintImage2</a></li> |
| <li><a href="fake/paramFromAnotherLib.html">paramFromAnotherLib</a></li> |
| <li><a href="fake/short.html">short</a></li> |
| <li><a href="fake/soIntense.html">soIntense</a></li> |
| <li><a href="fake/thisIsAlsoAsync.html">thisIsAlsoAsync</a></li> |
| <li><a href="fake/thisIsAsync.html">thisIsAsync</a></li> |
| <li><a class="deprecated" href="fake/topLevelFunction.html">topLevelFunction</a></li> |
| |
| <li class="section-title"><a href="fake/fake-library.html#enums">Enums</a></li> |
| <li><a href="fake/Color-class.html">Color</a></li> |
| |
| <li class="section-title"><a href="fake/fake-library.html#typedefs">Typedefs</a></li> |
| <li><a href="fake/Callback2.html">Callback2</a></li> |
| <li><a class="deprecated" href="fake/FakeProcesses.html">FakeProcesses</a></li> |
| <li><a href="fake/GenericTypedef.html">GenericTypedef</a></li> |
| <li><a href="fake/LotsAndLotsOfParameters.html">LotsAndLotsOfParameters</a></li> |
| <li><a href="fake/myCoolTypedef.html">myCoolTypedef</a></li> |
| <li><a href="fake/VoidCallback.html">VoidCallback</a></li> |
| |
| <li class="section-title"><a href="fake/fake-library.html#exceptions">Exceptions</a></li> |
| <li><a class="deprecated" href="fake/Doh-class.html">Doh</a></li> |
| <li><a href="fake/Oops-class.html">Oops</a></li> |
| </ol> |
| </div><!--/sidebar-offcanvas-right--> |
| |
| </div> <!-- row --> |
| </div> <!-- container --> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="container"> |
| <p class="text-center"> |
| <span class="no-break"> |
| test_package 0.0.1 |
| </span> |
| • |
| <span class="no-break"> |
| <a href="https://www.dartlang.org"> |
| <img src="static-assets/favicon.png" alt="Dart" title="Dart" width="16" height="16"> |
| </a> |
| </span> |
| • |
| <span class="copyright no-break"> |
| <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a> |
| </span> |
| |
| </p> |
| </div> |
| </div> |
| </footer> |
| |
| <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script> |
| <script src="static-assets/typeahead.bundle.min.js"></script> |
| <script src="static-assets/prettify.js"></script> |
| <script src="static-assets/URI.js"></script> |
| <script src="static-assets/script.js"></script> |
| |
| |
| </body> |
| |
| </html> |
