dojox/lang/docs.js

  • Provides:

    • dojox.lang.docs
  • dojo.declare

    • type
      Function
    • parameters:
      • name: (typeof )
    • source: [view]
        var clazz = defaultDeclare.apply(this, arguments);
        schemifyClass(clazz, name);
        return clazz;
    • chains:
      • defaultDeclare: (call)
    • mixins:
      • defaultDeclare: (normal)
    • summary
  • dojo.require

    • type
      Function
    • parameters:
      • moduleName: (typeof )
    • source: [view]
        requireDocs(moduleName);
        var module = defaultRequire.apply(this, arguments);
        return module;
    • chains:
      • defaultRequire: (call)
    • summary
  • dojox.lang.docs.init

    • type
      Function
    • parameters:
      • async: (typeof Boolean)
        If true, the documentation will be loaded asynchronously
    • source: [view]
        function loadFullDocs(){
         dojo.require = defaultRequire;
         requiredModules = null;
         try{
          dojo.xhrGet({
           sync:!async,
           url: dojo.baseUrl + '../util/docscripts/api.json',
           handleAs: 'text'
          }).addCallbacks(function(obj){
           _docs = (new Function("return " + obj))();
           obj = null;
           schemifyClass = actualSchemifyClass;


           for(var i in declaredClasses){
            schemifyClass(declaredClasses[i], i);
           }
           declaredClasses = null;
          }, error);
         }catch(e){
          error(e);
         }
        }

        
        if(initialized){
         return null;
        }
        initialized = true;


        var getSplitDocs = function(moduleName, sync){
         return dojo.xhrGet({
          sync: sync||!async,
          url: dojo.baseUrl + '../util/docscripts/api/' + moduleName + '.json',
          handleAs: 'text'
         }).addCallback(function(obj){
          obj = (new Function("return " + obj))();
          for(var clazz in obj){
           if(!_docs[clazz]){
            _docs[clazz] = obj[clazz];
           }
          }
         });
        };
        try{
         var firstMod = requiredModules.shift();
         getSplitDocs(firstMod, true).addCallbacks(function(){
          requireDocs = function(moduleName){
           if(!_docs[moduleName]){
            try{
             getSplitDocs(moduleName);
            }catch(e){
             _docs[moduleName] = {};
            }
           }
          };
          //console.log(requiredModules);
          dojo.forEach(requiredModules, function(mod){
           requireDocs(mod);
          });
          requiredModules = null;


          schemifyClass = actualSchemifyClass;


          for(i in declaredClasses){
           schemifyClass(declaredClasses[i], i);
          }
          declaredClasses = null;
         },loadFullDocs);
        }catch(e){
         loadFullDocs();
        }
        return null;
    • summary
      Loads the documentation and applies it to the previously defined classes
      and any future defined classes
  • dojox.lang.docs._loadedDocs

    • type
      Object
    • summary
  • dojox.lang.docs

    • type
      Object
    • summary
  • dojox.lang

    • type
      Object
    • summary
  • dojox

    • type
      Object
    • summary