Project Description
Visual Studio 2008 Javascript Intellisense script for Google Maps API v3
API V3 NOTES
// -----------------------------------------------------------------------------
// Google Maps API 3 Visual Studio Intellisense Helper Script
// -----------------------------------------------------------------------------
// Author: Sky Sanders - sky.sanders@gmail.com http://skysanders.net/subtext
// Project: Salient.GMap3.APIDoc (http://gmapvsdoc.codeplex.com/)
// -----------------------------------------------------------------------------
// USAGE:
// Add a reference tag to the top of your js file pointing to this script. (see sample)
// e.g.
// /// <reference path="google.maps.3.intellisense.v1.js" />
//
// If you desire gmap intellisense in an .aspx page include the vsdoc file after the google script reference and
// enclose it in an inline conditional that will evaluate to false at runtime. (see sample)
// <%if(false){%>
// <script src="js/google.maps.3.intellisense.v1.js" type="text/javascript"></script>
// <%}%>
//
//
// Event entries have been added as fields and are intended as a hint to use when adding an event handler
//
// SOURCES:
// VS Javascript Intellisense format: http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx
// Google Maps3 API: http://code.google.com/apis/maps/documentation/v3/reference.html
API V2 NOTES
This file is generated directly from the Google API specification page by a tool. The tool retrieves the API page, runs it through TIDY.exe to get xml, does some pretty ugly parsing and outputs the .js.
NOTE: I have just discovered that my syntax is incorrect. Parameter types are indeed displayable in vs intellisense. I will update the tool and .js file in the next few days.
// -----------------------------------------------------------------------------
// Google Maps API 2 Visual Studio Intellisense Helper Script
// -----------------------------------------------------------------------------
// Author: Sky Sanders - sky.sanders@gmail.com
// Project: Salient.GMap2.APIDoc (http://gmapvsdoc.codeplex.com/)
// -----------------------------------------------------------------------------
// USAGE:
// Add a reference tag to the top of your js file pointing to this script. (see sample)
// e.g.
// /// <reference path="salient.gmap2.vsdoc.js" />
//
// If you desire gmap intellisense in an .aspx page include the vsdoc file after the google script reference and
// enclose it in an inline conditional that will evaluate to false at runtime. (see sample)
// <%if(false){%>
// <script src="js/salient.gmap2.vsdoc.js" type="text/javascript"></script>
// <%}%>
//
// NOTES:
//
//
// Javascript intellisense is still very limited so parameter types have been included in the method signature using js comment syntax.
//
// e.g. GPolyline = function(latlngs/GLatLng[]/, color/String/, weight/Number/, opacity/Number/, opts/GPolylineOptions/)
//
// If this is not to your liking just do a global replace for /xxx/. Parameter types are the only instance of that comment syntax in the file.
//
//
// Events:
// Event entries have been added as fields and are intended as a hint to use when adding an event handler via GEvent namespace.
// They do not produce valid GMap api code.
// The name of the event should be used as the string literal and the arguments in the function closure
// when calling a binding method in the GEvent namespace.
//
// SOURCES:
// VS Javascript Intellisense format: http://weblogs.asp.net/bleroy/archive/2007/04/23/the-format-for-javascript-doc-comments.aspx
// Google Maps2 API: http://code.google.com/apis/maps/documentation/reference.html