Bug 1374427 - remove redundant function names in js-doc. r=mattn
MozReview-Commit-ID: 3EBT7CDl3pC
--- a/toolkit/components/satchel/FormHistory.jsm
+++ b/toolkit/components/satchel/FormHistory.jsm
@@ -437,18 +437,16 @@ function dbCreateAsyncStatement(aQuery,
stmt.params[field] = aParams[field];
}
}
return stmt;
}
/**
- * dbInit
- *
* Attempts to initialize the database. This creates the file if it doesn't
* exist, performs any migrations, etc.
*/
function dbInit() {
log("Initializing Database");
if (!_dbConnection.tableExists("moz_formhistory")) {
dbCreate();
@@ -539,18 +537,16 @@ function dbMigrate(oldVersion) {
_dbConnection.schemaVersion = DB_SCHEMA_VERSION;
_dbConnection.commitTransaction();
log("DB migration completed.");
}
/**
- * dbAreExpectedColumnsPresent
- *
* Sanity check to ensure that the columns this version of the code expects
* are present in the DB we're using.
* @returns {boolean} whether expected columns are present
*/
function dbAreExpectedColumnsPresent() {
for (let name in dbSchema.tables) {
let table = dbSchema.tables[name];
let query = "SELECT " +
@@ -565,18 +561,16 @@ function dbAreExpectedColumnsPresent() {
}
}
log("verified that expected columns are present in DB.");
return true;
}
/**
- * dbCleanup
- *
* Called when database creation fails. Finalizes database statements,
* closes the database connection, deletes the database file.
* @param {Object} dbFile database file to close
*/
function dbCleanup(dbFile) {
log("Cleaning up DB file - close & remove & backup");
// Create backup file
@@ -614,18 +608,16 @@ function dbClose(aShutdown) {
let thread = Services.tm.currentThread;
while (!closed) {
thread.processNextEvent(true);
}
}
}
/**
- * updateFormHistoryWrite
- *
* Constructs and executes database statements from a pre-processed list of
* inputted changes.
*
* @param {Array.<Object>} aChanges changes to form history
* @param {Object} aCallbacks
*/
function updateFormHistoryWrite(aChanges, aCallbacks) {
log("updateFormHistoryWrite " + aChanges.length);
@@ -733,18 +725,16 @@ function updateFormHistoryWrite(aChanges
}
/**
* Functions that expire entries in form history and shrinks database
* afterwards as necessary initiated by expireOldEntries.
*/
/**
- * expireOldEntriesDeletion
- *
* Removes entries from database.
*
* @param {number} aExpireTime expiration timestamp
* @param {number} aBeginningCount numer of entries at first
*/
function expireOldEntriesDeletion(aExpireTime, aBeginningCount) {
log("expireOldEntriesDeletion(" + aExpireTime + "," + aBeginningCount + ")");
@@ -757,18 +747,16 @@ function expireOldEntriesDeletion(aExpir
},
handleError(aError) {
log("expireOldEntriesDeletionFailure");
},
});
}
/**
- * expireOldEntriesVacuum
- *
* Counts number of entries removed and shrinks database as necessary.
*
* @param {number} aExpireTime expiration timestamp
* @param {number} aBeginningCount number of entries at first
*/
function expireOldEntriesVacuum(aExpireTime, aBeginningCount) {
FormHistory.count({}, {
handleResult(aEndingCount) {
--- a/toolkit/components/satchel/nsFormAutoComplete.js
+++ b/toolkit/components/satchel/nsFormAutoComplete.js
@@ -149,18 +149,16 @@ FormHistoryClient.prototype = {
FormHistoryClient.nextRequestID = 1;
function FormAutoComplete() {
this.init();
}
/**
- * FormAutoComplete
- *
* Implements the nsIFormAutoComplete interface in the main process.
*/
FormAutoComplete.prototype = {
classID: Components.ID("{c11c21b2-71c9-4f87-a0f8-5e13f50495fd}"),
QueryInterface: XPCOMUtils.generateQI([Ci.nsIFormAutoComplete, Ci.nsISupportsWeakReference]),
_prefBranch: null,
_debug: true, // mirrors browser.formfill.debug