More documentation clean-up for server APIs

pkg/analysis_server/lib/analysis/index_core.dart

Index: pkg/analysis_server/lib/analysis/index_core.dart
diff --git a/pkg/analysis_server/lib/analysis/index_core.dart b/pkg/analysis_server/lib/analysis/index_core.dart
index 2cc4b01020fbb9c37aa766f0a11195b75ff4d664..58e996ed6590bf10fd56e5c9fcc3c13b614fe8c2 100644
--- a/pkg/analysis_server/lib/analysis/index_core.dart
+++ b/pkg/analysis_server/lib/analysis/index_core.dart
@@ -12,10 +12,14 @@ import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/source.dart';
 
 /**
- * Return the integer value that corresponds to the given [str].
- * The value of [str] may be `null`.
+ * Return the integer value that corresponds to the given [string]. The value of
+ * [string] may be `null`.
+ *
+ * Clients are not expected to implement this signature. A function of this type
+ * is provided by the framework to clients in order to implement the method
+ * [IndexableObjectKind.encodeHash].
  */
-typedef int StringToInt(String str);
+typedef int StringToInt(String string);
 
 /**
  * An object that can have a [Relationship] with various [Location]s in a code
@@ -124,20 +128,6 @@ abstract class IndexableObjectKind {
   }
 }
 
-// A sketch of what the driver routine might look like:
-//
-//void buildIndexForSource(AnalysisContext context, Source source) {
-//  IndexStoreImpl store;
-//  store.aboutToIndex(context, source);
-//  try {
-//    for (IndexContributor contributor in contributors) {
-//      contributor.contributeTo(store, context, source);
-//    }
-//  } finally {
-//    store.doneIndexing();
-//  }
-//}
-
 /**
  * An object used to add relationships to the index.
  *