bin
/
tourism-wxapp


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
							<!-- start:source.tmpl.hbs -->
<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
		<title>MyApi.js</title>
		<!--[if lt IE 9]>
		<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
		<![endif]-->
		<link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
		<link type="text/css" rel="stylesheet" href="css/bootstrap.min.css">
		<link type="text/css" rel="stylesheet" href="css/prism.min.css">
		<link type="text/css" rel="stylesheet" href="css/template.min.css">
		<script type="text/javascript">
			window.TEMPLATE_OPTIONS = {"includeDate":true,"dateFormat":"Do MMM YYYY","systemName":"FooDoc","systemSummary":"A Bootstrap and Handlebars based template for JSDoc3.","systemLogo":"","systemColor":"","navMembers":[{"kind":"class","title":"Classes","summary":"All documented classes."},{"kind":"external","title":"Externals","summary":"All documented external members."},{"kind":"global","title":"Globals","summary":"All documented globals."},{"kind":"mixin","title":"Mixins","summary":"All documented mixins."},{"kind":"interface","title":"Interfaces","summary":"All documented interfaces."},{"kind":"module","title":"Modules","summary":"All documented modules."},{"kind":"namespace","title":"Namespaces","summary":"All documented namespaces."},{"kind":"tutorial","title":"Tutorials","summary":"All available tutorials."}],"footer":"","copyright":"FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.","linenums":true,"collapseSymbols":true,"inverseNav":true,"inlineNav":false,"outputSourceFiles":true,"sourceRootPath":null,"disablePackagePath":true,"outputSourcePath":false,"showTableOfContents":true,"showAccessFilter":true,"analytics":null,"methodHeadingReturns":true,"sort":"linenum, longname, version, since","search":true,"favicon":null,"stylesheets":[],"scripts":[],"monospaceLinks":false,"cleverLinks":false};
			window.DOCLET_TOC_ENABLED = false;
			window.DOCLET_AFILTER_ENABLED = false;
		</script>
</head>
<body>
	<!-- start:navbar.hbs -->
	<header class="navbar navbar-default navbar-fixed-top navbar-inverse">
		<div class="container">
			<div class="navbar-header">
				<a class="navbar-brand" href="index.html">
					FooDoc
				</a>
				<!-- displayed on small devices -->
				<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
					<span class="icon-bar"></span>
					<span class="icon-bar"></span>
					<span class="icon-bar"></span>
				</button>
			</div>
			<div class="navbar-collapse collapse" id="topNavigation">
				<ul class="nav navbar-nav">
								<li class="dropdown">
									<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Globals<b class="caret"></b></a>
									<ul class="dropdown-menu">
											<li><a href="global.html#SomeType">SomeType</a></li>
									</ul>
								</li>
								<li class="dropdown">
									<a href="list_class.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
									<ul class="dropdown-menu">
											<li><a href="CustomError.html">CustomError</a></li>
											<li><a href="GlobalClass.html">GlobalClass</a></li>
											<li><a href="MyApi.Child.html">MyApi.Child</a></li>
											<li><a href="MyApi.Class.html">MyApi.Class</a></li>
									</ul>
								</li>
								<li class="dropdown">
									<a href="list_namespace.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
									<ul class="dropdown-menu">
											<li><a href="MyApi.html">MyApi</a></li>
											<li><a href="MyApi.utils.html">MyApi.utils</a></li>
									</ul>
								</li>
								<li class="dropdown">
									<a href="list_tutorial.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
									<ul class="dropdown-menu">
											<li><a href="tutorial-brush-teeth.html">Brush Teeth</a></li>
											<li><a href="tutorial-drive-car.html">Drive Car</a></li>
									</ul>
								</li>
				</ul>
					<!-- start:lunr-search-navbar.hbs -->
					<form class="navbar-form navbar-right" role="search">
						<div class="input-group">
							<input type="text" class="form-control" placeholder="Search" id="lunr-search-input">
							<div class="input-group-btn">
								<button class="btn btn-default" id="lunr-search-submit">
									<i class="glyphicon glyphicon-search"></i>
								</button>
							</div>
						</div>
					</form>
					<!-- start:lunr-search-navbar.hbs -->		</div>
		</div>
	</header>
	<!-- end:navbar.hbs -->		<div class="page-header">
			<div class="container">
				<span class="kind">source</span>
				<h1><span class="name">MyApi.js</span></h1>
			</div>
		</div>
	<div class="container content">
		<div class="row">
			<div class="col-md-12 main-content">
		<section class="source-section">
			<article></article>
			<pre class="prettyprint source language-javascript line-numbers"><code class="language-javascript">/**
 * @summary This is the test summary for the `MyApi` namespace.
 * @namespace MyApi
 * @description This is the longer description for the namespace giving a better idea about the code contained within it.
 */
window.MyApi = {
	/**
	 * @summary This is a static member of the namespace.
	 * @memberof MyApi.
	 * @name staticMember
	 * @type {string}
	 * @default I'm a member of the MyApi namespace.
	 */
	staticMember: "I'm a member of the MyApi namespace."
};

/**
 * @summary This is a test type definition on the MyApi namespace.
 * @memberof MyApi~
 * @typedef {Object} Object
 * @prop {string} name - This is the name of the test object.
 * @prop {boolean} [enabled=false] - This is whether or not the test object is enabled. Defaults to `false`.
 */

/**
 * @summary This is the summary of the MyApi test class, test `markdown`.
 * @memberof MyApi
 * @constructor Class
 * @param {string} arg1 - The first test arg, test `markdown`.
 * @param {...string} [arg2=false] - A repeatable, optional argument with a default value of false, test `markdown`.
 * @description This is the description for the class this is meant to be a more in depth explanation of what this class does and it's general use case, test `markdown`
 * @example {@caption You can provide example captions with `markdown` and specify the language to use when rendering the code, defaults to `javascript`.}
 * var gc = new GlobalClass("arg1", "arg2");
 * @example {@lang xml}
 * &lt;head>
 * 	&lt;title>HTML Highlighting&lt;/title>
 * 	&lt;script>
 * 	  // supports embedded languages
 * 		var gc = new GlobalClass("arg1", "arg2");
 * 	&lt;/script>
 * &lt;/head>
 */
MyApi.Class = function(arg1, arg2){
	/**
	 * @summary I'm a member of the class.
	 * @memberof MyApi.Class#
	 * @name publicMember
	 * @type {string}
	 * @default "I'm an instance member."
	 */
	this.publicMember = "I'm an instance member.";
	/**
	 * @summary I'm a protected member of the class.
	 * @memberof MyApi.Class#
	 * @name protectedMember
	 * @type {string}
	 * @default "I'm a protected member."
	 * @protected
	 */
	this.protectedMember = "I'm a protected member.";
	/**
	 * @summary I'm a private member of the class.
	 * @memberof MyApi.Class#
	 * @name _privateMember
	 * @type {string}
	 * @default "I'm a private member."
	 * @private
	 */
	this._privateMember = "I'm a private member.";
};

/**
 * @summary This is a test instance method of the MyApi test class, test `markdown`.
 * @memberof MyApi.Class#
 * @function testMethod
 * @param {*} value - Any value, test `markdown`
 * @param {Object} obj - The first object of what could be many, test `markdown`
 * @param {...Object} [objN] - Any additional objects, test `markdown`
 * @returns {Object} The combination of all the objects, test `markdown`.
 * @description This method is not overridden in the {@link MyApi.Child} class but is simply inherited.
 * @fires MyApi.Class~"test.my-api"
 * @throws {CustomError} This is thrown when some condition fails within this method.
 */
MyApi.Class.prototype.testMethod = function(value, obj, objN){
	/**
	 * @summary This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.
	 * @memberof MyApi.Class~
	 * @event "test.my-api"
	 * @param {Event} e - The event object.
	 * @param {*} custom - Some custom parameter passed to any listeners.
	 */
	throw new CustomError("Some custom error.");
};

/**
 * @summary This is a another test instance method of the MyApi test class, test `markdown`.
 * @memberof MyApi.Class#
 * @function anotherMethod
 * @param {*} value - Any value, test `markdown`
 * @param {Object} obj - The first object of what could be many, test `markdown`
 * @param {...Object} [objN] - Any additional objects, test `markdown`
 * @returns {Object} The combination of all the objects, test `markdown`.
 * @description This method is overridden in the {@link MyApi.Child} class and should remove the exception documentation as it no longer applies.
 * @fires MyApi.Class~"another.my-api"
 * @throws {CustomError} This is thrown when some condition fails within this method.
 */
MyApi.Class.prototype.anotherMethod = function(value, obj, objN){
	/**
	 * @summary This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.
	 * @memberof MyApi.Class~
	 * @event "another.my-api"
	 * @param {Event} e - The event object.
	 * @param {*} custom - Some custom parameter passed to any listeners.
	 */
};

/**
 * @summary This is a test type definition on the MyApi.Class class.
 * @memberof MyApi.Class~
 * @typedef {Object} Object
 * @prop {string} name - The name of the test object.
 * @prop {boolean} [enabled=false] - Whether or not the test object is enabled. Defaults to `false`.
 * @prop {Object} sub - An object containing a subset of properties.
 * @prop {number} sub.id - The subset id.
 * @prop {boolean} [sub.name="Sub Options"] - The name of the sub object. Defaults to `"Sub Options"`.
 */

/**
 * @summary This is the summary of the MyApi child class, test `markdown`.
 * @memberof MyApi
 * @constructor Child
 * @extends MyApi.Class
 */
MyApi.Child = function(){
	/**
	 * @summary I'm a protected member of the class.
	 * @memberof MyApi.Child#
	 * @name protectedMember
	 * @type {string}
	 * @default "I'm a protected member."
	 * @protected
	 */
	this.protectedMember = "I'm a protected member.";
};

/**
 * @summary This is a another test instance method of the MyApi child class, test `markdown`.
 * @memberof MyApi.Child#
 * @function anotherMethod
 * @param {*} value - Any value, test `markdown`
 * @param {Object} obj - The first object of what could be many, test `markdown`
 * @param {...Object} [objN] - Any additional objects, test `markdown`
 * @returns {Object} The combination of all the objects, test `markdown`.
 * @description This method overrides the {@link MyApi.Class#anotherMethod} and should remove the exception documentation as it no longer applies. The event should also be updated to reflect it is raised by this class and not the inherited one.
 * @fires MyApi.Child~"another.my-api"
 */
MyApi.Child.prototype.anotherMethod = function(value, obj, objN){
	/**
	 * @summary This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.
	 * @memberof MyApi.Child~
	 * @event "another.my-api"
	 * @param {Event} e - The event object.
	 * @param {*} custom - Some custom parameter passed to any listeners.
	 */
};</code></pre>
		</section>
			</div>
		</div>
	</div>
	<footer>
				<div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
			<div class="generated-by">Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on 1st May 2018 using the <a href="https://github.com/steveush/foodoc">FooDoc template</a>.</div>
	</footer>
	<script src="js/jquery.min.js"></script>
	<script src="js/bootstrap.min.js"></script>
	<script src="js/clipboard.min.js"></script>
	<script src="js/prism.min.js"></script>
	<script src="js/template.min.js"></script>
		<!-- start:lunr-search-modal.hbs -->
		<div class="modal fade" id="lunr-search-modal">
			<div class="modal-dialog">
				<div class="modal-content">
					<div class="modal-header">
						<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
						<h4 class="modal-title">Search results</h4>
					</div>
					<div class="modal-body" id="lunr-search-body">
					</div>
					<div class="modal-footer" id="lunr-search-footer">
						<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
					</div>
				</div><!-- /.modal-content -->
			</div><!-- /.modal-dialog -->
		</div>
		<!-- end:lunr-search-modal.hbs -->		<script src="js/lunr.min.js"></script>
	
</body>
</html>
<!-- end:source.tmpl.hbs -->