More documentation

Author: tomsdev

PathUtils.js

@@ -36,9 +36,7 @@ define(function (require, exports, module) {
      * @returns {string}
      */
     function convertRelativePathToFullPath(relativePath, directoryPath) {
-        //TODO: handle parent relative path (starting with ../)
         var fullPath = directoryPath + "/" + relativePath;
-        console.log("FullPath calculated: ", fullPath);
         return fullPath;
     }
 

TypeScript/TypeScriptDocument.js

@@ -183,7 +183,6 @@ define(function (require, exports, module) {
      */
     TypeScriptDocument.prototype.getFullPath = function (relativePath) {
         var parentPath = PathUtils.getParentPath(this.doc.file.fullPath);
-        // WARNING: won't work with parent relative path for the moment
         return PathUtils.convertRelativePathToFullPath(relativePath, parentPath);
     };
 

TypeScript/TypeScriptService.js

@@ -25,6 +25,11 @@
 /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50, regexp: true */
 /*global define, brackets, $ */
 
+/**
+ * TypeScriptService provides methods to create or get from cache TypeScriptSession
+ * objects. It maintains a cache of this sessions. It listens to the activeEditorChange
+ * event and changes the current session with a new one bound to the new active document.
+ */
 define(function (require, exports, module) {
     "use strict";
 

TypeScript/TypeScriptSession.js

@@ -106,12 +106,10 @@ define(function (require, exports, module) {
         //TODO: do it only when the change is at the top of the file (before the first line of code)
         var references = this.tsDoc.getReferences(),
             that = this;
-
         // Attach added references
         if (references.added.length > 0) {
             this._attachReferencedDocuments(references.added);
         }
-
         // Detach removed references
         references.removed.forEach(function (relativePath) {
             var fullPath = that.tsDoc.getFullPath(relativePath);
@@ -120,7 +118,6 @@ define(function (require, exports, module) {
                 that._detachDocument(doc);
             }
         });
-
         this.tsDoc.updateScriptWithChanges(doc, changes);
         this.tsDoc.triggerHandlerChange();
     };
@@ -139,11 +136,12 @@ define(function (require, exports, module) {
             console.error("Document for this path already in _attachedDocuments: ", doc.file.fullPath);
             return;
         }
-
+        // Listen to change event
         doc.addRef();
         $(doc).on(TypeScriptUtils.eventName("change"), handleChangeFn);
-        this._attachedDocuments[doc.file.fullPath] = doc;
 
+        this._attachedDocuments[doc.file.fullPath] = doc;
+        // Add the script content
         this.tsDoc.updateScriptWithText(doc);
         console.log("Script attached: ", doc.file.fullPath);
     };
@@ -180,7 +178,7 @@ define(function (require, exports, module) {
         DocumentManager.getDocumentForPath(fullPath)
             .done(function (referencedDoc) {
                 that._attachDocument(referencedDoc,
-                    that._handleReferencedDocumentChange.bind(that));
+                                     that._handleReferencedDocumentChange.bind(that));
                 result.resolve();
             })
             .fail(function () {

TypeScriptCodeHints/main.js

@@ -307,9 +307,9 @@ define(function (require, exports, module) {
         }
 
         TypeScriptService.getSession(this.editor.document).done(function (session) {
-            // if the user typed something that changed the current document
+            // If the user typed something that changed the current document
             if (implicitChar) {
-                // wait for the current typescript document "change" event because typescript
+                // Wait for the current typescript document "change" event because typescript
                 // has to process the file with the changes before getting the completions
                 $(session.tsDoc).on(eventName("change"), function () {
                     $(session.tsDoc).off(eventName("change"));