Skip to content

Commit 26197e0

Browse files
GuyTheFlowerGuyTheFlower
committed
started to restructure code, but along the way spending some time figuring out how to document it
1 parent 0bba484 commit 26197e0

42 files changed

Lines changed: 93528 additions & 238 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎learning_web_proj/cum_effects_v2/conf.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"tags" : {
3+
"allowUnknownTags" : true
4+
},
5+
"plugins" : ["plugins/markdown"],
6+
"templates" : {
7+
"cleverLinks" : false,
8+
"monospaceLinks" : false,
9+
"default" : {
10+
"outputSourceFiles" : true
11+
},
12+
"systemName" : "Cumulative Effects Demo",
13+
"footer" : "my footer",
14+
"copyright" : "DocStrap Copyright © 2012-2013 The contributors to the JSDoc3 and DocStrap projects.",
15+
"navType" : "vertical",
16+
"theme" : "spacelab",
17+
"linenums" : true,
18+
"collapseSymbols" : true,
19+
"inverseNav" : true
20+
},
21+
"markdown" : {
22+
"parser" : "gfm",
23+
"hardwrap" : true
24+
}
25+
}
26+

‎learning_web_proj/cum_effects_v2/lyrConfig.js‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,30 @@
44
* are part of the application
55
* @namespace lyrConfig
66
*/
7-
lyrConfig = (function(google) {
7+
var lyrConfig = (function(google) {
88
'use strict';
99
var lyrConfig, googleMapTypes;
1010
lyrConfig = {};
1111

12+
/**
13+
* @typedef googleMapConfigsArray
14+
* @type {object}
15+
* @property {string} label - The name for the type of map
16+
* @property {object} params - object that can be fed to the options parameter when creating a google layer.
17+
* @property {number} params.numZoomLevels - number of zoom levels to use for this basemap
18+
* @property {number} params.MAX_ZOOM_LEVEL - The maximum number of allowable zoom levels
19+
* @property {object} params.type - The google map type. see @link https://developers.google.com/maps/documentation/javascript/maptypes#BasicMapTypes
20+
*/
1221

22+
1323
/**
1424
* returns an array of objects that describing the different
1525
* google maps that can be used as base maps
1626
* @name lyrConfig#getGoogleMapTypeConfigs
1727
* @function
1828
* @private
29+
* @returns {googleMapConfigsArray} an object describing the different google map layers to create.
30+
* @memberof lyrConfig
1931
*/
2032
function getGoogleMapTypeConfigs() {
2133
var types, streetMaps, hybrid;
@@ -44,12 +56,27 @@ lyrConfig = (function(google) {
4456
return [streetMaps, hybrid, sat];
4557
}
4658

59+
60+
/**
61+
* @name test2
62+
* @function
63+
* @memberof lyrConfig
64+
*/
65+
lyrConfig.test2 = function (test) {
66+
console.log("nothing");
67+
};
68+
69+
4770
/**
4871
* test method does this work in jsdoc
4972
* @name lyrConfig#testMethod
5073
* @function
74+
* @param {Object} test
75+
* @param {String} test.param1 - This is a parameter
76+
* @param {number} test.param2 - another examples
77+
* @memberof lyrConfig
5178
*/
52-
lyrConfig.testMethod = function () {
79+
lyrConfig.testMethod = function (test) {
5380
console.log("nothing")
5481
};
5582

0 commit comments

Comments
 (0)