Add doc comment

jagare · Aug 29, 2014 · 66030b2 · 66030b2
1 parent 79caf99
commit 66030b2
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/modules/components/NotFoundRoute.js b/modules/components/NotFoundRoute.js
@@ -1,6 +1,13 @@
 var merge = require('react/lib/merge');
 var Route = require('./Route');
 
+/**
+ * A <NotFoundRoute> is a special kind of <Route> that
+ * renders when the beginning of its parent's path matches
+ * but none of its siblings do, including any <DefaultRoute>.
+ * Only one such route may be used at any given level in the
+ * route hierarchy.
+ */
 function NotFoundRoute(props) {
   return Route(
     merge(props, {