remove the creative commons footer text (#1515)

* remove cc footer text

* update the generated files

* add cc footer text back for the sdk docs

* update a string interpolation location

Author: devoncarew

bin/dartdoc.dart

@@ -5,6 +5,7 @@
 library dartdoc.bin;
 
 import 'dart:io';
+import 'dart:isolate' show Isolate;
 
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/src/dart/sdk/sdk.dart';
@@ -44,10 +45,7 @@ main(List<String> arguments) async {
     exit(1);
   }
 
-  bool sdkDocs = false;
-  if (args['sdk-docs']) {
-    sdkDocs = true;
-  }
+  final bool sdkDocs = args['sdk-docs'];
 
   if (args['show-progress']) {
     _showProgress = true;
@@ -63,7 +61,8 @@ main(List<String> arguments) async {
   Directory inputDir = new Directory(args['input']);
   if (!inputDir.existsSync()) {
     stderr.writeln(
-        " fatal error: unable to locate the input directory at ${inputDir.path}.");
+        " fatal error: unable to locate the input directory at ${inputDir
+            .path}.");
     exit(1);
   }
 
@@ -95,6 +94,14 @@ main(List<String> arguments) async {
 
   List<String> footerTextFilePaths =
       args['footer-text'].map(_resolveTildePath).toList() as List<String>;
+
+  // If we're generating docs for the Dart SDK, we insert a copyright footer.
+  if (sdkDocs) {
+    Uri footerCopyrightUri = await Isolate.resolvePackageUri(
+        Uri.parse('package:dartdoc/src/sdk_footer_text.html'));
+    footerTextFilePaths = [footerCopyrightUri.toFilePath()];
+  }
+
   for (String footerFilePath in footerTextFilePaths) {
     if (!new File(footerFilePath).existsSync()) {
       stderr.writeln(
@@ -122,8 +129,9 @@ main(List<String> arguments) async {
       : new PackageMeta.fromDir(inputDir);
 
   if (!packageMeta.isValid) {
+    final String firstError = packageMeta.getInvalidReasons().first;
     stderr.writeln(
-        ' fatal error: Unable to generate documentation: ${packageMeta.getInvalidReasons().first}.');
+        ' fatal error: Unable to generate documentation: $firstError.');
     exit(1);
   }
 
@@ -245,8 +253,8 @@ ArgParser _createArgsParser() {
   parser.addOption('footer-text',
       allowMultiple: true,
       splitCommas: true,
-      help:
-          'paths to footer-text files (optional text next to the copyright).');
+      help: 'paths to footer-text files '
+          '(optional text next to the package name and version).');
   parser.addOption('exclude',
       allowMultiple: true, splitCommas: true, help: 'Library names to ignore.');
   parser.addOption('include',
@@ -311,6 +319,7 @@ ArgParser _createArgsParser() {
 }
 
 int _progressCounter = 0;
+
 void _onProgress(var file) {
   if (_showProgress && _progressCounter % 5 == 0) {
     stdout.write('.');

lib/src/sdk_footer_text.html

@@ -0,0 +1,4 @@
+•
+<span class="copyright no-break">
+  <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
+</span>

lib/templates/_footer.html

@@ -4,10 +4,6 @@
   <span class="no-break">
     {{package.name}} {{package.version}}
   </span>
-  &bull;
-  <span class="copyright no-break">
-    <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
-  </span>
 
   <!-- footer-text placeholder -->
 </footer>

testing/test_package_docs/anonymous_library/anonymous_library-library.html

@@ -100,10 +100,6 @@ <h5>library anonymous_library</h5>
   <span class="no-break">
     test_package 0.0.1
   </span>
-  &bull;
-  <span class="copyright no-break">
-    <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
-  </span>
 
 </footer>
 

testing/test_package_docs/anonymous_library/doesStuff.html

@@ -70,10 +70,6 @@ <h5>function doesStuff</h5>
   <span class="no-break">
     test_package 0.0.1
   </span>
-  &bull;
-  <span class="copyright no-break">
-    <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
-  </span>
 
 </footer>
 

testing/test_package_docs/another_anonymous_lib/another_anonymous_lib-library.html

@@ -100,10 +100,6 @@ <h5>library another_anonymous_lib</h5>
   <span class="no-break">
     test_package 0.0.1
   </span>
-  &bull;
-  <span class="copyright no-break">
-    <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
-  </span>
 
 </footer>
 

testing/test_package_docs/another_anonymous_lib/greeting.html

@@ -70,10 +70,6 @@ <h5>function greeting</h5>
   <span class="no-break">
     test_package 0.0.1
   </span>
-  &bull;
-  <span class="copyright no-break">
-    <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
-  </span>
 
 </footer>
 

testing/test_package_docs/code_in_comments/code_in_comments-library.html

@@ -94,10 +94,6 @@ <h5>library code_in_comments</h5>
   <span class="no-break">
     test_package 0.0.1
   </span>
-  &bull;
-  <span class="copyright no-break">
-    <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
-  </span>
 
 </footer>
 

testing/test_package_docs/css/css-library.html

@@ -104,10 +104,6 @@ <h5>library css</h5>
   <span class="no-break">
     test_package 0.0.1
   </span>
-  &bull;
-  <span class="copyright no-break">
-    <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
-  </span>
 
 </footer>
 

testing/test_package_docs/css/theOnlyThingInTheLibrary.html

@@ -71,10 +71,6 @@ <h5>top-level property theOnlyThingInTheLibrary</h5>
   <span class="no-break">
     test_package 0.0.1
   </span>
-  &bull;
-  <span class="copyright no-break">
-    <a href="http://creativecommons.org/licenses/by-sa/4.0/">cc license</a>
-  </span>
 
 </footer>