Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/document/DocumentManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*/
Expand Down
11 changes: 6 additions & 5 deletions src/editor/Editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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;
Expand Down Expand Up @@ -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(),
Expand All @@ -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
Expand Down Expand Up @@ -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");
Expand Down
10 changes: 5 additions & 5 deletions src/editor/EditorManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -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(...)>}
*/
Expand Down Expand Up @@ -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.");
Expand Down Expand Up @@ -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() {
Expand Down
4 changes: 2 additions & 2 deletions src/language/LanguageManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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 () {
Expand Down
4 changes: 2 additions & 2 deletions src/project/FileViewController.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -68,7 +68,7 @@ define(function (require, exports, module) {

/**
* @private
* @see FileViewController.getFileSelectionFocus()
* @see #getFileSelectionFocus
*/
var _fileSelectionFocus = PROJECT_MANAGER;

Expand Down
6 changes: 3 additions & 3 deletions src/project/ProjectModel.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ define(function (require, exports, module) {

/**
* @private
* See shouldShow
* @see #shouldShow
*/
function _shouldShowName(name) {
return !name.match(_exclusionListRegEx);
Expand Down Expand Up @@ -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 = "";

Expand Down Expand Up @@ -1224,7 +1224,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) {
Expand Down
4 changes: 2 additions & 2 deletions src/project/WorkingSetView.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [];
Expand Down
2 changes: 1 addition & 1 deletion src/utils/ExtensionUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/view/MainViewManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {};
Expand Down Expand Up @@ -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
*/
Expand Down
10 changes: 5 additions & 5 deletions src/view/Pane.js
Original file line number Diff line number Diff line change
Expand Up @@ -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};
Expand Down Expand Up @@ -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;
Expand Down