More options file validation (and API iteration).

pkg/analyzer/lib/src/generated/error.dart

 // Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 library engine.error;
 
 import 'dart:collection';
 
 import 'package:source_span/source_span.dart';
 
@@ skipping 278 matching lines @@
   /**
    * Set the value of the given [property] to the given [value]. Using a value
    * of `null` will effectively remove the property from this error.
    */
   void setProperty(ErrorProperty property, Object value) {
     _propertyMap[property] = value;
   }
 }
 
 /**
- * The error codes used for errors in analysis options files.
+ * The error codes used for errors in analysis options files. The convention for
+ * this class is for the name of the error code to indicate the problem that
+ * caused the error to be generated and for the error message to explain what is
+ * wrong and, when appropriate, how the problem can be corrected.
  */
 class AnalysisOptionsErrorCode extends ErrorCode {
   /**
    * An error code indicating that there is a syntactic error in the file.
    *
    * Parameters:
    * 0: the error message from the parse error
    */
   static const AnalysisOptionsErrorCode PARSE_ERROR =
       const AnalysisOptionsErrorCode('PARSE_ERROR', '{0}');
 
   /**
    * Initialize a newly created error code to have the given [name].
    */
   const AnalysisOptionsErrorCode(String name, String message,
       [String correction])
       : super(name, message, correction);
 
   @override
   ErrorSeverity get errorSeverity => ErrorSeverity.ERROR;
 
   @override
   ErrorType get type => ErrorType.COMPILE_TIME_ERROR;
 }
 
 /**
- * The error codes used for warnings in analysis options files.
+ * The error codes used for warnings in analysis options files. The convention
+ * for this class is for the name of the error code to indicate the problem that
+ * caused the error to be generated and for the error message to explain what is
+ * wrong and, when appropriate, how the problem can be corrected.
  */
 class AnalysisOptionsWarningCode extends ErrorCode {
   /**
    * An error code indicating that a plugin is being configured with an
    * unsupported option.
    *
    * Parameters:
    * 0: the plugin name
    * 1: the unsupported option key
    */
@@ skipping 4729 matching lines @@
    * Initialize a newly created error code to have the given [name].
    */
   const TodoCode(String name) : super(name, "{0}");
 
   @override
   ErrorSeverity get errorSeverity => ErrorSeverity.INFO;
 
   @override
   ErrorType get type => ErrorType.TODO;
 }