tyler-morrison
8/31/2015 - 2:00 AM

Sass Doc Block

////
/// This is a poster comment.
/// It will apply annotations to all items from file.
/// @group API
/// @author Elliot Mitchum
////

/// Name
/// Description
///
/// @todo Task to be done
///
/// @since version
/// @author Author's name
/// @group helpers
/// @deprecated Deprecation related message
/// @see {mixin} other-item
/// @link http://example.com
/// @type Bool | String
/// @access private
/// @alias other-item
/// @content [Description]
/// @output Description
/// @throw Error related message
/// @return {type} description
///
/// @prop {type} base.property [default] - description
///
/// @require item
/// @require {type} item
/// @require {type} item - description
/// @require {type} item description
/// @require {type} item <link>
/// @require {type} item description <link>
///
/// @param {type} $name
/// @param {type | othertype} $name
/// @param {type} $name - description
/// @param {type} $name [default value] - description
///
/// @example
///   4 + 2 = 8
///   4 / 2 = 2
///
/// @example scss - Clamp function
///   clamp(42, $min: 13, $max: 37)
///   // 37