dojox/help/_base.js

• Provides:

  • dojox.help._base

• Requires:

  • dojox.rpc.Service in common
  • dojo.io.script in common

• dojox.help

  • summary

    Adds the help function to all variables.

  • type

    Object

• dojox.help.locate

  • parameters:
    • searchFor: (typeof String)
    • searchIn: (typeof String|Object|String[]|Object[])

      The namespaces to search in. Defaults to dojox.help._namespaces

    • maxResults: (typeof Number)

      The maximum number of results.

  • summary

    Search for dojo functionality that has something to do with the given string.

  • description

    Search for locally available data; variable names and any cached
    documentation results for matches containing our search parameter
    searchFor
    The string to search for.

  • type

    Function

• dojox.help.refresh

  • parameters:
    • namespace: (typeof String)

      The string-representation of a namespace.

    • recursive: (typeof Boolean)

      Whether to recurse through the namespace.

  • summary

    Useful if you reset some values, and want to restore their
    help function

  • type

    Function

• dojox.help.noConflict

  • parameters:
    • item: (typeof Object)

      If you pass an item, only that item will be cleaned

  • summary

    Use this function when you want to resolve the problems
    created by including a dojox.help package.

  • type

    Function

• dojox.help.init

  • parameters:
    • namespaces: (typeof String[])

      Any namespaces to add to the default (dojox.help._namespaces)

    • noConflict: (typeof Boolen)

      Whether to start in noConflict mode

  • summary

    Should be called by one of the implementations. Runs startup code

  • type

    Function

• dojox.help._noConflict

  • parameters:
    • item
  • type

    Function

• dojox.help._namespaces

  • type

    Array

• dojox.help._rpc

  • type

    Object

• dojox.help._attributes

  • type

    Array

• dojox.help._clean

  • parameters:
    • self
  • type

    Function

• dojox.help._displayLocated

  • parameters:
    • located
  • summary

    Stub function to be overridden in one of the dojox.help packages

  • type

    Function

• dojox.help._displayHelp

  • parameters:
    • loading
    • obj
  • summary

    Stub function to be overridden in one of the dojox.help packages

  • type

    Function

• dojox.help._addVersion

  • parameters:
    • obj
  • type

    Function

• dojox.help._stripPrototype

  • parameters:
    • original
  • type

    Function

• dojox.help._help

  • type

    Function

• dojox.help._help.__name__

• dojox.help._help.__searched__

  • type

    Object

• dojox.help._parse

  • parameters:
    • data
  • type

    Function

• dojox.help._parse.__parameters__

• dojox.help._parse.__source__

  • type

    Object

• dojox.help._toStrings

  • type

    Object

• dojox.help._toString

  • parameters:
    • data
  • type

    Function

• dojox.help._toString.__parameters__

  • type

    Array

• dojox.help._toString.__searching__

  • type

    Object

• dojox.help._toString.__output__

  • type

    Object

• dojox.help.__toString

  • type

    Function

• dojox.help._overrides

  • type

    Array

• dojox.help._recursions

  • type

    Array

• dojox.help._names

  • type

    Object

• dojox.help._recurse

  • parameters:
    • namespace: (typeof String)
    • recursive: (typeof Boolean)
  • type

    Function

• dojox.help.__recurse

  • parameters:
    • namespace
    • root
    • name
    • items
    • recursive
  • type

    Function

• dojox.help._base

  • type

    Object

• dojox

  • type

    Object