add comments for update-ghpages.dart

whesse · Jul 29, 2013 · d05ee98 · d05ee98
1 parent 48f0543
commit d05ee98
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/update-ghpages.dart b/update-ghpages.dart
@@ -1,5 +1,10 @@
 import 'package:ghpages_generator/ghpages_generator.dart' as gh;
 
+/**
+ * Run this file to update the _gh-pages_ branch with a fresh dartdoc of
+ * the library and examples compiled through dart2js.
+ * Once ran you only have to push the _gh-pages_ branch to github.
+ */
 main() {
   new gh.Generator()
   ..setDartDoc(['lib/js.dart'], excludedLibs: ['metadata'], outDir: 'docs')