Skip to content

Commit

Permalink
Miscellaneous API doc formatting fixes, refs #13101 !strict.
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.dojotoolkit.org/src/dojo/trunk@28791 560b804f-0ae3-0310-86f3-f6aa0a117693
  • Loading branch information
wkeese committed Jun 11, 2012
1 parent c625bc8 commit 7223016
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 19 deletions.
22 changes: 11 additions & 11 deletions _base/lang.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,12 @@ define(["./kernel", "../has", "../sniff"], function(dojo, has){
// executes a so-called "shallow copy" and aggregate types are copied/added by reference.
// example:
// make a shallow copy of an object
// | var copy = lang.mixin({}, source);
// | var copy = lang.mixin({}, source);
// example:
// many class constructors often take an object which specifies
// values to be configured on the object. In this case, it is
// often simplest to call `lang.mixin` on the `this` object:
// | declare("acme.Base", null, {
// | declare("acme.Base", null, {
// | constructor: function(properties){
// | // property configuration:
// | lang.mixin(this, properties);
Expand All @@ -129,26 +129,26 @@ define(["./kernel", "../has", "../sniff"], function(dojo, has){
// | },
// | quip: "I wasn't born yesterday, you know - I've seen movies.",
// | // ...
// | });
// | });
// |
// | // create an instance of the class and configure it
// | var b = new acme.Base({quip: "That's what it does!" });
// | // create an instance of the class and configure it
// | var b = new acme.Base({quip: "That's what it does!" });
// example:
// copy in properties from multiple objects
// | var flattened = lang.mixin(
// | var flattened = lang.mixin(
// | {
// | name: "Frylock",
// | braces: true
// | },
// | {
// | name: "Carl Brutanananadilewski"
// | }
// | );
// | );
// |
// | // will print "Carl Brutanananadilewski"
// | console.log(flattened.name);
// | // will print "true"
// | console.log(flattened.braces);
// | // will print "Carl Brutanananadilewski"
// | console.log(flattened.name);
// | // will print "true"
// | console.log(flattened.braces);

if(!dest){ dest = {}; }
for(var i = 1, l = arguments.length; i < l; i++){
Expand Down
12 changes: 8 additions & 4 deletions back.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ define(["./_base/config", "./_base/lang", "./sniff", "./dom", "./dom-construct",
var historyCounter;

function handleBackButton(){
//summary: private method. Do not call this directly.
// summary:
// private method. Do not call this directly.

//The "current" page is always at the top of the history stack.
var current = historyStack.pop();
Expand Down Expand Up @@ -76,12 +77,14 @@ define(["./_base/config", "./_base/lang", "./sniff", "./dom", "./dom-construct",
back.goForward = handleForwardButton;

function createState(url, args, hash){
//summary: private method. Do not call this directly.
// summary:
// private method. Do not call this directly.
return {"url": url, "kwArgs": args, "urlHash": hash}; //Object
}

function getUrlQuery(url){
//summary: private method. Do not call this directly.
// summary:
// private method. Do not call this directly.
var segments = url.split("?");
if(segments.length < 2){
return null; //null
Expand All @@ -92,7 +95,8 @@ define(["./_base/config", "./_base/lang", "./sniff", "./dom", "./dom-construct",
}

function loadIframeHistory(){
//summary: private method. Do not call this directly.
// summary:
// private method. Do not call this directly.
var url = (config["dojoIframeHistoryUrl"] || require.toUrl("./resources/iframe_history.html")) + "?" + (new Date()).getTime();
moveForward = true;
if(historyIframe){
Expand Down
9 changes: 6 additions & 3 deletions io/iframe.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,13 @@ var iframe = lang.delegate(_iframe, {
//Set up the deferred.
var dfd = xhr._ioSetArgs(args,
function(/*Deferred*/dfd){
//summary: canceller function for xhr._ioSetArgs call.
// summary:
// canceller function for xhr._ioSetArgs call.
rDfd && rDfd.cancel();
},
function(/*Deferred*/dfd){
//summary: okHandler function for xhr._ioSetArgs call.
// summary:
// okHandler function for xhr._ioSetArgs call.
var value = null,
ioArgs = dfd.ioArgs;
try{
Expand All @@ -131,7 +133,8 @@ var iframe = lang.delegate(_iframe, {
return value;
},
function(/*Error*/error, /*Deferred*/dfd){
//summary: errHandler function for xhr._ioSetArgs call.
// summary:
// errHandler function for xhr._ioSetArgs call.
dfd.ioArgs._hasError = true;
return error;
}
Expand Down
2 changes: 1 addition & 1 deletion number.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ number._applyPattern = function(/*Number*/ value, /*String*/ pattern, /*number._
// pattern:
// a pattern string as described by
// [unicode.org TR35](http://www.unicode.org/reports/tr35/#Number_Format_Patterns)
// options: dojo.number.__FormatOptions?
// options: number.__FormatOptions?
// _applyPattern is usually called via `dojo.number.format()` which
// populates an extra property in the options parameter, "customs".
// The customs object specifies group and decimal parameters if set.
Expand Down

0 comments on commit 7223016

Please sign in to comment.