docs cleanup

Modernizr · Feb 18, 2015 · 8cbb3e8 · 8cbb3e8
1 parent bd8c8a4
commit 8cbb3e8
Showing 1 changed file with 9 additions and 8 deletions.
diff --git a/src/mq.js b/src/mq.js
@@ -1,12 +1,13 @@
 define(['ModernizrProto', 'testMediaQuery'], function( ModernizrProto, testMediaQuery ) {
-  // Modernizr.mq tests a given media query, live against the current state of the window
-  // A few important notes:
-  //   * If a browser does not support media queries at all (eg. oldIE) the mq() will always return false
-  //   * A max-width or orientation query will be evaluated against the current state, which may change later.
-  //   * You must specify values. Eg. If you are testing support for the min-width media query use:
-  //       Modernizr.mq('(min-width:0)')
-  // usage:
-  // Modernizr.mq('only screen and (max-width:768)')
+  /** Modernizr.mq tests a given media query, live against the current state of the window
+   * A few important notes:
+        * If a browser does not support media queries at all (eg. oldIE) the mq() will always return false
+        * A max-width or orientation query will be evaluated against the current state, which may change later.
+        * You must specify values. Eg. If you are testing support for the min-width media query use:
+              Modernizr.mq('(min-width:0)')
+   * usage:
+   * Modernizr.mq('only screen and (max-width:768)')
+   */
   var mq = ModernizrProto.mq = testMediaQuery;
   return mq;
 });