doc(*): fix screwed up formatting in objectid implementation

Author: mbroadst

lib/bson/objectid.js

@@ -11,22 +11,23 @@ var MACHINE_ID = parseInt(Math.random() * 0xffffff, 10);
 
 // Regular expression that checks for hex value
 var checkForHexRegExp = new RegExp('^[0-9a-fA-F]{24}$');
+var hasBufferType = false;
 
 // Check if buffer exists
 try {
-  if (Buffer && Buffer.from) var hasBufferType = true;
+  if (Buffer && Buffer.from) hasBufferType = true;
 } catch (err) {
   hasBufferType = false;
 }
 
 /**
-* Create a new ObjectID instance
-*
-* @class
-* @param {(string|number)} id Can be a 24 byte hex string, 12 byte binary string or a Number.
-* @property {number} generationTime The generation time of this ObjectId instance
-* @return {ObjectID} instance of ObjectID.
-*/
+ * Create a new ObjectID instance
+ *
+ * @class
+ * @param {(string|number)} id Can be a 24 byte hex string, 12 byte binary string or a Number.
+ * @property {number} generationTime The generation time of this ObjectId instance
+ * @return {ObjectID} instance of ObjectID.
+ */
 var ObjectID = function ObjectID(id) {
   // Duck-typing to support ObjectId from different npm packages
   if (id instanceof ObjectID) return id;
@@ -81,11 +82,11 @@ for (var i = 0; i < 256; i++) {
 }
 
 /**
-* Return the ObjectID id as a 24 byte hex string representation
-*
-* @method
-* @return {string} return the 24 byte hex string representation.
-*/
+ * Return the ObjectID id as a 24 byte hex string representation
+ *
+ * @method
+ * @return {string} return the 24 byte hex string representation.
+ */
 ObjectID.prototype.toHexString = function() {
   if (ObjectID.cacheHexString && this.__id) return this.__id;
 
@@ -113,34 +114,34 @@ ObjectID.prototype.toHexString = function() {
 };
 
 /**
-* Update the ObjectID index used in generating new ObjectID's on the driver
-*
-* @method
-* @return {number} returns next index value.
-* @ignore
-*/
+ * Update the ObjectID index used in generating new ObjectID's on the driver
+ *
+ * @method
+ * @return {number} returns next index value.
+ * @ignore
+ */
 ObjectID.prototype.get_inc = function() {
   return (ObjectID.index = (ObjectID.index + 1) % 0xffffff);
 };
 
 /**
-* Update the ObjectID index used in generating new ObjectID's on the driver
-*
-* @method
-* @return {number} returns next index value.
-* @ignore
-*/
+ * Update the ObjectID index used in generating new ObjectID's on the driver
+ *
+ * @method
+ * @return {number} returns next index value.
+ * @ignore
+ */
 ObjectID.prototype.getInc = function() {
   return this.get_inc();
 };
 
 /**
-* Generate a 12 byte id buffer used in ObjectID's
-*
-* @method
-* @param {number} [time] optional parameter allowing to pass in a second based timestamp.
-* @return {Buffer} return the 12 byte id buffer string.
-*/
+ * Generate a 12 byte id buffer used in ObjectID's
+ *
+ * @method
+ * @param {number} [time] optional parameter allowing to pass in a second based timestamp.
+ * @return {Buffer} return the 12 byte id buffer string.
+ */
 ObjectID.prototype.generate = function(time) {
   if ('number' !== typeof time) {
     time = ~~(Date.now() / 1000);
@@ -175,12 +176,12 @@ ObjectID.prototype.generate = function(time) {
 };
 
 /**
-* Converts the id into a 24 byte hex string for printing
-*
-* @param {String} format The Buffer toString format parameter.
-* @return {String} return the 24 byte hex string representation.
-* @ignore
-*/
+ * Converts the id into a 24 byte hex string for printing
+ *
+ * @param {String} format The Buffer toString format parameter.
+ * @return {String} return the 24 byte hex string representation.
+ * @ignore
+ */
 ObjectID.prototype.toString = function(format) {
   // Is the id a buffer then use the buffer toString method to return the format
   if (this.id && this.id.copy) {
@@ -192,33 +193,31 @@ ObjectID.prototype.toString = function(format) {
 };
 
 /**
-* Converts to a string representation of this Id.
-*
-* @return {String} return the 24 byte hex string representation.
-* @ignore
-*/
+ * Converts to a string representation of this Id.
+ *
+ * @return {String} return the 24 byte hex string representation.
+ * @ignore
+ */
 ObjectID.prototype.inspect = ObjectID.prototype.toString;
 
 /**
-* Converts to its JSON representation.
-*
-* @return {String} return the 24 byte hex string representation.
-* @ignore
-*/
+ * Converts to its JSON representation.
+ *
+ * @return {String} return the 24 byte hex string representation.
+ * @ignore
+ */
 ObjectID.prototype.toJSON = function() {
   return this.toHexString();
 };
 
 /**
-* Compares the equality of this ObjectID with `otherID`.
-*
-* @method
-* @param {object} otherID ObjectID instance to compare against.
-* @return {boolean} the result of comparing two ObjectID's
-*/
+ * Compares the equality of this ObjectID with `otherID`.
+ *
+ * @method
+ * @param {object} otherID ObjectID instance to compare against.
+ * @return {boolean} the result of comparing two ObjectID's
+ */
 ObjectID.prototype.equals = function equals(otherId) {
-  // var id;
-
   if (otherId instanceof ObjectID) {
     return this.toString() === otherId.toString();
   } else if (
@@ -240,11 +239,11 @@ ObjectID.prototype.equals = function equals(otherId) {
 };
 
 /**
-* Returns the generation date (accurate up to the second) that this ID was generated.
-*
-* @method
-* @return {date} the generation date
-*/
+ * Returns the generation date (accurate up to the second) that this ID was generated.
+ *
+ * @method
+ * @return {date} the generation date
+ */
 ObjectID.prototype.getTimestamp = function() {
   var timestamp = new Date();
   var time = this.id[3] | (this.id[2] << 8) | (this.id[1] << 16) | (this.id[0] << 24);
@@ -253,24 +252,24 @@ ObjectID.prototype.getTimestamp = function() {
 };
 
 /**
-* @ignore
-*/
+ * @ignore
+ */
 ObjectID.index = ~~(Math.random() * 0xffffff);
 
 /**
-* @ignore
-*/
+ * @ignore
+ */
 ObjectID.createPk = function createPk() {
   return new ObjectID();
 };
 
 /**
-* Creates an ObjectID from a second based number, with the rest of the ObjectID zeroed out. Used for comparisons or sorting the ObjectID.
-*
-* @method
-* @param {number} time an integer number representing a number of seconds.
-* @return {ObjectID} return the created ObjectID
-*/
+ * Creates an ObjectID from a second based number, with the rest of the ObjectID zeroed out. Used for comparisons or sorting the ObjectID.
+ *
+ * @method
+ * @param {number} time an integer number representing a number of seconds.
+ * @return {ObjectID} return the created ObjectID
+ */
 ObjectID.createFromTime = function createFromTime(time) {
   var buffer = new Buffer([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
   // Encode time into first 4 bytes
@@ -283,7 +282,6 @@ ObjectID.createFromTime = function createFromTime(time) {
 };
 
 // Lookup tables
-//var encodeLookup = '0123456789abcdef'.split('');
 var decodeLookup = [];
 i = 0;
 while (i < 10) decodeLookup[0x30 + i] = i++;
@@ -295,12 +293,12 @@ var convertToHex = function(bytes) {
 };
 
 /**
-* Creates an ObjectID from a hex string representation of an ObjectID.
-*
-* @method
-* @param {string} hexString create a ObjectID from a passed in 24 byte hexstring.
-* @return {ObjectID} return the created ObjectID
-*/
+ * Creates an ObjectID from a hex string representation of an ObjectID.
+ *
+ * @method
+ * @param {string} hexString create a ObjectID from a passed in 24 byte hexstring.
+ * @return {ObjectID} return the created ObjectID
+ */
 ObjectID.createFromHexString = function createFromHexString(string) {
   // Throw an error if it's not a valid setup
   if (typeof string === 'undefined' || (string != null && string.length !== 24)) {
@@ -325,11 +323,11 @@ ObjectID.createFromHexString = function createFromHexString(string) {
 };
 
 /**
-* Checks if a value is a valid bson ObjectId
-*
-* @method
-* @return {boolean} return true if the value is a valid bson ObjectId, return false otherwise.
-*/
+ * Checks if a value is a valid bson ObjectId
+ *
+ * @method
+ * @return {boolean} return true if the value is a valid bson ObjectId, return false otherwise.
+ */
 ObjectID.isValid = function isValid(id) {
   if (id == null) return false;
 
@@ -358,8 +356,8 @@ ObjectID.isValid = function isValid(id) {
 };
 
 /**
-* @ignore
-*/
+ * @ignore
+ */
 Object.defineProperty(ObjectID.prototype, 'generationTime', {
   enumerable: true,
   get: function() {