/**
 * Private access.
 * @access private
 * or
 * @private
 */
function privateFunction () {}
 
/**
 * Public access.
 * @access public
 * or
 * @public
 */
function publicFunction () {}

/**
 * Specifiy an callback
 * @callback name Description.
 *
 * example:
 * @callback myCallback I call it, whenever I like to.
 *                      Also, it accept multiline descriptions.
 * @param error {Error} An error object, if an error happend.
 * @param result {Object} The result of the async stuff.
 */
 
/**
 * Do some async stuff
 *
 * @param stuff {Object} Object with a buch of stuff.
 * @param cb {myCallback} The callback I'll call.
 */
function doAsync(stuff, cb) {
  // do async stuff
 
  cb(null, result);
};

/**
 * A constant variable.
 * @constant name {Type} Description.
 *
 * example:
 * @constant MY_CONSTANT {Number} My constant number.
 */
var MY_CONSTANT = 10;

/**
 * Indicate that a function is a constructor.
 * @constructor
 */
function Constructor () {}

/**
 * Indicate that a function is deprecated.
 * @deprecated
 */
function someOldFunction () {}

/**
 * Specify an example (one is also auto generated).
 * @example your example,
 *          accepts multiline comments.
 *
 * @example
 * var parser = require('parser');
 * var doc = parser(input, output, 'markdown');
 * // or don't save it
 * var doc = parser(input, 'markdown');
 */
function parser (input, output, result) {}

/**
 * A function parameter.
 * @param name {Type} Description.
 *
 * example:
 * @param param1
 * @param param2 {String} 
 * @param param3 My parameter.
 * @param param4 {Object} My parameter.
 * @param param4.subparameter {String} Property of parameter.
 */
function doStuff (param1, param2, param3, param4) {}

/**
 * What a function returns.
 * @return {Type} Description.
 * or
 * @returns {Type} Description.
 *
 * example:
 * @return {Object} My return object.
 * @return .subparameter {String} Property of the return object.
 */
function returnObject () {
  return {
    subparameter: 'Hi'
  };
}

/**
 * Description of the the this object
 * @this Desciption.
 * or define a property of this
 * @this .property {Type} Description.
 *
 * example:
 * @this .name {String} Name of the error.
 */
function Constructor () {}

/**
 * An error that a function might throw
 * @throw Error description.
 * or
 * @throws Error description.
 *
 * example:
 * @throw You broke me! This happend because..?
 *        I don't know.
 */
function throwError () {
  throw new Error('You broke me! This happend because..? I don\'t know.');
}

/**
 * When we still need to do some stuff, globally or per function.
 * @todo finish this.
 * or
 * @todo
 * - finish..
 * - this.
 *
 * example:
 * @todo Make better documentation.
 * @todo
 * - Write some more tests.
 * - Make this work.
 * - Then make it faster.
 */