Merge pull request #9782 from adobe/jbalsas/links_api_fixes

redmunds · redmunds · commit 56662baaa17f · 2014-11-16T13:52:32.000-08:00
Fix some @link and @see tags
diff --git a/src/document/DocumentManager.js b/src/document/DocumentManager.js
@@ -115,7 +115,7 @@ define(function (require, exports, module) {
     /**
      * Returns the existing open Document for the given file, or null if the file is not open ('open'
      * means referenced by the UI somewhere). If you will hang onto the Document, you must addRef()
-     * it; see {@link getDocumentForPath()} for details.
+     * it; see {@link #getDocumentForPath} for details.
      * @param {!string} fullPath
      * @return {?Document}
      */
diff --git a/src/editor/Editor.js b/src/editor/Editor.js
@@ -1248,7 +1248,7 @@ define(function (require, exports, module) {
      * @param {boolean} center true to center the viewport
      * @param {number} centerOptions Option value, or 0 for no options; one of the BOUNDARY_* constants above.
      * @param {?string} origin An optional string that describes what other selection or edit operations this
-     *      should be merged with for the purposes of undo. See Document.replaceRange() for more details.
+     *      should be merged with for the purposes of undo. See {@link Document#replaceRange} for more details.
      */
     Editor.prototype.setSelection = function (start, end, center, centerOptions, origin) {
         this.setSelections([{start: start, end: end || start}], center, centerOptions, origin);
@@ -1267,7 +1267,7 @@ define(function (require, exports, module) {
      * @param {boolean} center true to center the viewport around the primary selection.
      * @param {number} centerOptions Option value, or 0 for no options; one of the BOUNDARY_* constants above.
      * @param {?string} origin An optional string that describes what other selection or edit operations this
-     *      should be merged with for the purposes of undo. See Document.replaceRange() for more details.
+     *      should be merged with for the purposes of undo. See {@link Document#replaceRange} for more details.
      */
     Editor.prototype.setSelections = function (selections, center, centerOptions, origin) {
         var primIndex = selections.length - 1, options;
@@ -2002,7 +2002,7 @@ define(function (require, exports, module) {
      *     the start and end.
      * @return {?(Object|string)} Name of syntax-highlighting mode, or object containing a "name" property
      *     naming the mode along with configuration options required by the mode.
-     * @see {@link LanguageManager#getLanguageForPath()} and {@link Language#getMode()}.
+     * @see {@link LanguageManager::#getLanguageForPath} and {@link LanguageManager::Language#getMode}.
      */
     Editor.prototype.getModeForRange = function (start, end, knownMixed) {
         var outerMode = this._codeMirror.getMode(),
@@ -2028,7 +2028,7 @@ define(function (require, exports, module) {
      *
      * @return {?(Object|string)} Name of syntax-highlighting mode, or object containing a "name" property
      *     naming the mode along with configuration options required by the mode.
-     * @see {@link LanguageManager#getLanguageForPath()} and {@link Language#getMode()}.
+     * @see {@link LanguageManager::#getLanguageForPath} and {@link LanguageManager::Language#getMode}.
      */
     Editor.prototype.getModeForSelection = function () {
         // Check for mixed mode info
@@ -2081,7 +2081,8 @@ define(function (require, exports, module) {
     /**
      * Gets the syntax-highlighting mode for the document.
      *
-     * @return {Object|String} Object or Name of syntax-highlighting mode; see {@link LanguageManager#getLanguageForPath()} and {@link Language#getMode()}.
+     * @return {Object|String} Object or Name of syntax-highlighting mode
+     * @see {@link LanguageManager::#getLanguageForPath|LanguageManager.getLanguageForPath} and {@link LanguageManager::Language#getMode|Language.getMode}.
      */
     Editor.prototype.getModeForDocument = function () {
         return this._codeMirror.getOption("mode");
diff --git a/src/editor/EditorManager.js b/src/editor/EditorManager.js
@@ -81,23 +81,23 @@ define(function (require, exports, module) {
     
     /**
      * Registered inline-editor widget providers sorted descending by priority. 
-     * @see {@link #registerInlineEditProvider()}.
+     * @see {@link #registerInlineEditProvider}.
      * @type {Array.<{priority:number, provider:function(...)}>}
      * @private
      */
     var _inlineEditProviders = [];
     
     /**
      * Registered inline documentation widget providers sorted descending by priority.
-     * @see {@link #registerInlineDocsProvider()}.
+     * @see {@link #registerInlineDocsProvider}.
      * @type {Array.<{priority:number, provider:function(...)}>}
      * @private
      */
     var _inlineDocsProviders = [];
     
     /**
      * Registered jump-to-definition providers. 
-     * @see {@link #registerJumpToDefProvider()}.
+     * @see {@link #registerJumpToDefProvider}.
      * @private
      * @type {Array.<function(...)>}
      */
@@ -598,7 +598,7 @@ define(function (require, exports, module) {
     
     /**
      * @deprecated Register a View Factory instead  
-     * @see MainViewManager.registerViewFactory()
+     * @see MainViewFactory::#registerViewFactory
      */
     function registerCustomViewer() {
         throw new Error("EditorManager.registerCustomViewer() has been removed.");
@@ -685,7 +685,7 @@ define(function (require, exports, module) {
      * Returns the current active editor (full-sized OR inline editor). This editor may not 
      * have focus at the moment, but it is visible and was the last editor that was given 
      * focus. Returns null if no editors are active.
-     * @see getFocusedEditor()
+     * @see #getFocusedEditor
      * @return {?Editor}
      */
     function getActiveEditor() {
diff --git a/src/language/LanguageManager.js b/src/language/LanguageManager.js
@@ -807,7 +807,7 @@ define(function (require, exports, module) {
      * Returns either a language associated with the mode or the fallback language.
      * Used to disambiguate modes used by multiple languages.
      * @param {!string} mode The mode to associate the language with
-     * @return {Language} This language if it uses the mode, or whatever {@link LanguageManager#_getLanguageForMode} returns
+     * @return {Language} This language if it uses the mode, or whatever {@link #_getLanguageForMode} returns
      */
     Language.prototype.getLanguageForMode = function (mode) {
         if (mode === this._mode) {
@@ -846,7 +846,7 @@ define(function (require, exports, module) {
     
     /**
      * Trigger the "languageModified" event if this language is registered already
-     * @see _triggerLanguageModified
+     * @see #_triggerLanguageModified
      * @private
      */
     Language.prototype._wasModified = function () {
diff --git a/src/project/FileViewController.js b/src/project/FileViewController.js
@@ -59,7 +59,7 @@ define(function (require, exports, module) {
     /** 
      * Tracks whether a "currentFileChange" notification occured due to a call to 
      * openAndSelectDocument.
-     * @see FileviewController.openAndSelectDocument
+     * @see #openAndSelectDocument
      * @private 
      */
     var _curDocChangedDueToMe = false;
@@ -68,7 +68,7 @@ define(function (require, exports, module) {
 
     /**
      * @private
-     * @see FileViewController.getFileSelectionFocus()
+     * @see #getFileSelectionFocus
      */
     var _fileSelectionFocus = PROJECT_MANAGER;
     
diff --git a/src/project/ProjectModel.js b/src/project/ProjectModel.js
@@ -92,7 +92,7 @@ define(function (require, exports, module) {
 
     /**
      * @private
-     * See shouldShow
+     * @see #shouldShow
      */
     function _shouldShowName(name) {
         return !name.match(_exclusionListRegEx);
@@ -244,7 +244,7 @@ define(function (require, exports, module) {
      * @type {string}
      * 
      * Encoded URL
-     * @see getBaseUrl(), setBaseUrl()
+     * @see {@link ProjectModel#getBaseUrl}, {@link ProjectModel#setBaseUrl}
      */
     ProjectModel.prototype._projectBaseUrl = "";
 
@@ -1236,7 +1236,7 @@ define(function (require, exports, module) {
      * Returns the full path to the welcome project, which we open on first launch.
      *
      * @param {string} sampleUrl URL for getting started project
-     * @param {string} initialPath Path to Brackets directory (see FileUtils.getNativeBracketsDirectoryPath())
+     * @param {string} initialPath Path to Brackets directory (see {@link FileUtils::#getNativeBracketsDirectoryPath})
      * @return {!string} fullPath reference
      */
     function _getWelcomeProjectPath(sampleUrl, initialPath) {
diff --git a/src/project/WorkingSetView.js b/src/project/WorkingSetView.js
@@ -57,14 +57,14 @@ define(function (require, exports, module) {
 
     /**
      * Icon Providers
-     * @see {@link WorkingSetView#addIconProvider()}
+     * @see {@link #addIconProvider}
      * @private
      */
     var _iconProviders = [];
     
     /**
      * Class Providers
-     * @see {@link WorkingSetView#addClassProvider()}
+     * @see {@link #addClassProvider}
      * @private
      */
     var _classProviders = [];
diff --git a/src/utils/ExtensionUtils.js b/src/utils/ExtensionUtils.js
@@ -72,7 +72,7 @@ define(function (require, exports, module) {
     /**
      * getModuleUrl returns different urls for win platform
      * so that's why we need a different check here
-     * @see getModuleUrl()
+     * @see #getModuleUrl
      * @param {!string} pathOrUrl that should be checked if it's absolute
      * @return {!boolean} returns true if pathOrUrl is absolute url on win platform
      *                    or when it's absolute path on other platforms
diff --git a/src/view/MainViewManager.js b/src/view/MainViewManager.js
@@ -227,7 +227,7 @@ define(function (require, exports, module) {
      * localized pane titles 
      * @type {Object.<FIRST_PANE|SECOND_PANE, <VERTICAL.string, HORIZONTAL.string>}}
      *  Localized string for first and second panes in the current orientation.  
-     * @see {@link getPaneTitle()} for more information
+     * @see {@link #getPaneTitle} for more information
      * @private
      */
     var _paneTitles  = {};
@@ -846,7 +846,7 @@ define(function (require, exports, module) {
      * sorts the pane's view list 
      * @param {!string} paneId - id of the pane to sort, ALL_PANES or ACTIVE_PANE
      * @param {sortFunctionCallback} compareFn - callback to determine sort order (called on each item)
-     * @see {@link Pane.sortViewList()} for more information
+     * @see {@link Pane#sortViewList} for more information
      * @see {@link https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array/sort|Sort Array - MDN}
      * @private
      */
diff --git a/src/view/Pane.js b/src/view/Pane.js
@@ -170,8 +170,8 @@ define(function (require, exports, module) {
      * @param {boolean} requestIndex - true to request an index, false if not
      * @param {number} index - the index to request
      * @return {indexRequested:boolean, index:number} an object that can be pased to 
-     * Pane._addToViewList to insert the item at a specific index
-     * @see {Pane._addToViewList}
+     * {@link Pane#addToViewList} to insert the item at a specific index
+     * @see Pane#addToViewList
      */
     function _makeIndexRequestObject(requestIndex, index) {
         return {indexRequested: requestIndex, index: index};
@@ -585,23 +585,23 @@ define(function (require, exports, module) {
     
     /** 
      * Return value from reorderItem when the Item was not found 
-     * @see {@link reorderItem()}
+     * @see {@link Pane#reorderItem}
      * @const 
      */
     Pane.prototype.ITEM_NOT_FOUND = -1;
     
     /** 
      * Return value from reorderItem when the Item was found at its natural index 
      * and the workingset does not need to be resorted
-     * @see {@link reorderItem()}
+     * @see {@link Pane#reorderItem}
      * @const 
      */
     Pane.prototype.ITEM_FOUND_NO_SORT = 0;
     
     /** 
      * Return value from reorderItem when the Item was found and reindexed 
      * and the workingset needs to be resorted
-     * @see {@link reorderItem()}
+     * @see {@link Pane#reorderItem}
      * @const 
      */
     Pane.prototype.ITEM_FOUND_NEEDS_SORT = 1;
