Fix misc spelling issues (#2468)

* Fix misc spelling issues

* Address review comments

Author: parlough

README.md

@@ -374,7 +374,7 @@ as well as available in the process environment.
 
 ### Injecting HTML
 
-It happens rarely, but sometimes what you really need is to inject some raw HTML
+It rarely happens, but sometimes what you really need is to inject some raw HTML
 into the dartdoc output, without it being subject to Markdown processing
 beforehand. This can be useful when the output of an external tool is HTML, for
 instance. This is where the `{@inject-html}...{@end-inject-html}` tags come in.
@@ -411,7 +411,7 @@ all the used libraries, even from other packages, to the list of the documented
 The source linking feature in dartdoc is a little tricky to use, since pub packages do not actually
 include enough information to link back to source code and that's the context in which documentation
 is generated for the pub site.  This means that for now, it must be manually specified in
-dartdoc_options.yaml what revision to use.  It is currently recommended practice to
+dartdoc_options.yaml what revision to use.  It is currently a recommended practice to
 specify a revision in dartdoc_options.yaml that points to the same revision as your public package.
 If you're using a documentation staging system outside of Dart's pub site, override the template and
 revision on the command line with the head revision number.  You can use the branch name,

lib/resources/script.js

@@ -77,7 +77,7 @@ function initScrollSave() {
   var mainContent = document.getElementById('dartdoc-main-content');
   var rightSidebar = document.getElementById('dartdoc-sidebar-right');
 
-  // For portablility, use two different ways of attaching saveLeftScroll to events.
+  // For portability, use two different ways of attaching saveLeftScroll to events.
   leftSidebar.onscroll = saveLeftScroll;
   leftSidebar.addEventListener("scroll", saveLeftScroll, true);
   mainContent.onscroll = saveMainContentScroll;

lib/src/dartdoc_options.dart

@@ -730,14 +730,14 @@ class DartdocOptionFileSynth<T> extends DartdocOption<T>
   final T Function(DartdocSyntheticOption<T>, Folder) _compute;
 
   DartdocOptionFileSynth(
-      String name, this._compute, ResourceProvider resourceprovider,
+      String name, this._compute, ResourceProvider resourceProvider,
       {bool mustExist = false,
       String help = '',
       OptionKind optionIs = OptionKind.other,
       bool parentDirOverridesChild,
       ConvertYamlToType<T> convertYamlToType})
       : super(name, null, help, optionIs, mustExist, convertYamlToType,
-            resourceprovider) {
+            resourceProvider) {
     _parentDirOverridesChild = parentDirOverridesChild;
   }
 

lib/src/markdown_processor.dart

@@ -349,7 +349,7 @@ class _MarkdownCommentReference {
 
   /// [_impliedUnnamedConstructor] is memoized in [__impliedUnnamedConstructor],
   /// but even after it is initialized, it may be null. This bool represents the
-  /// initializiation state.
+  /// initialization state.
   bool __impliedUnnamedConstructorIsSet = false;
 
   /// Returns the name of the implied unnamed constructor if there is one, or
@@ -624,14 +624,14 @@ class _MarkdownCommentReference {
   }
 
   /// Returns the unnamed constructor for class [toConvert] or the class for
-  /// constructor [toConvert], or just [toConvert], based on hueristics.
+  /// constructor [toConvert], or just [toConvert], based on heuristics.
   ///
   /// * If an unnamed constructor is implied in the comment reference, and
   ///   [toConvert] is a class with the same name, the class's unnamed
   ///   constructor is returned.
   /// * Otherwise, if [toConvert] is an unnamed constructor, its enclosing
   ///   class is returned.
-  /// * Othwerwise, [toConvert] is returned.
+  /// * Otherwise, [toConvert] is returned.
   ModelElement _convertConstructors(ModelElement toConvert) {
     if (_impliedUnnamedConstructor != null) {
       if (toConvert is Class && toConvert.name == _impliedUnnamedConstructor) {

lib/src/model/dynamic.dart

@@ -17,7 +17,7 @@ class Dynamic extends ModelElement {
   @override
   ModelElement get enclosingElement => throw UnsupportedError('');
 
-  /// And similiarly, even if someone references it directly it can have
+  /// And similarly, even if someone references it directly it can have
   /// no hyperlink.
   @override
   String get href => null;

lib/src/model/never.dart

@@ -17,7 +17,7 @@ class NeverType extends ModelElement {
   @override
   ModelElement get enclosingElement => throw UnsupportedError('');
 
-  /// And similiarly, even if someone references it directly it can have
+  /// And similarly, even if someone references it directly it can have
   /// no hyperlink.
   @override
   String get href => null;

lib/src/model_utils.dart

@@ -140,12 +140,12 @@ bool hasPublicName(Element e) => !hasPrivateName(e);
 
 /// Strip leading dartdoc comments from the given source code.
 String stripDartdocCommentsFromSource(String source) {
-  var remainer = source.trimLeft();
+  var remainder = source.trimLeft();
   var sanitizer = const HtmlEscape();
-  var lineComments = remainer.startsWith('///') ||
-      remainer.startsWith(sanitizer.convert('///'));
-  var blockComments = remainer.startsWith('/**') ||
-      remainer.startsWith(sanitizer.convert('/**'));
+  var lineComments = remainder.startsWith('///') ||
+      remainder.startsWith(sanitizer.convert('///'));
+  var blockComments = remainder.startsWith('/**') ||
+      remainder.startsWith(sanitizer.convert('/**'));
 
   return source.split('\n').where((String line) {
     if (lineComments) {
@@ -171,8 +171,8 @@ String stripDartdocCommentsFromSource(String source) {
 
 /// Strip the common indent from the given source fragment.
 String stripIndentFromSource(String source) {
-  var remainer = source.trimLeft();
-  var indent = source.substring(0, source.length - remainer.length);
+  var remainder = source.trimLeft();
+  var indent = source.substring(0, source.length - remainder.length);
   return source.split('\n').map((line) {
     line = line.trimRight();
     return line.startsWith(indent) ? line.substring(indent.length) : line;

test/end2end/model_special_cases_test.dart

@@ -3,7 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 /// This test library handles checks against the model for configurations
-/// that require different PacakgeGraph configurations.  Since those
+/// that require different PackageGraph configurations.  Since those
 /// take a long time to initialize, isolate them here to keep model_test
 /// fast.
 library dartdoc.model_special_cases_test;

test/end2end/model_test.dart

@@ -963,11 +963,11 @@ void main() {
                 '<a href="${HTMLBASE_PLACEHOLDER}fake/SpecialList/operator_get.html">SpecialList.operator []</a> '));
       }, skip: 'https://github.com/dart-lang/dartdoc/issues/1285');
 
-      test('codeifies a class from the SDK', () {
+      test('adds <code> tag to a class from the SDK', () {
         expect(docsAsHtml, contains('<code>String</code>'));
       });
 
-      test('codeifies a reference to its parameter', () {
+      test('adds <code> tag to a reference to its parameter', () {
         expect(docsAsHtml, contains('<code>value</code>'));
       });
 
@@ -2015,7 +2015,7 @@ void main() {
       expect(fancyList.publicInstanceFields, hasLength(1));
     });
 
-    test('get contants', () {
+    test('get constants', () {
       expect(fancyList.publicConstantFields, hasLength(0));
     });
 
@@ -2519,7 +2519,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
       expect(m1.enclosingElement.name, equals(classB.name));
     });
 
-    test('overriden method', () {
+    test('overridden method', () {
       expect(m1.overriddenElement.runtimeType.toString(), 'Method');
     });
 
@@ -2941,7 +2941,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
     });
 
     test(
-        'property with setter and getter and comments with asterixes do not show asterixes',
+        'property with setter and getter and comments with asterisks do not show asterisks',
         () {
       expect(sFromApple.documentationAsHtml.contains('/**'), isFalse);
     });
@@ -3882,7 +3882,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
   });
 
   group('Sorting by name', () {
-    // Order by uppercased lexical ordering for non-digits,
+    // Order by uppercase lexical ordering for non-digits,
     // lexicographical ordering of embedded digit sequences.
     var names = [
       r'',

testing/test_package/lib/fake.dart

@@ -313,7 +313,7 @@ class Cool {
 /// A map initialization making use of optional const.
 const Map<int, String> myMap = {1: "hello"};
 
-/// A variable initalization making use of optional new.
+/// A variable initialization making use of optional new.
 Cool aCoolVariable = Cool();
 
 /// Perfect for mix-ins.