Regression: Objective-C enums no longer documented

[jpsim]

At some point between cbd9625 and 2e9a724, Objective-C enums stopped being documented.

Before:

SourceKitten/Tests/SourceKittenFramework/Fixtures/Realm.json

Lines 1559 to 1679 in cbd9625

	{
	"key.kind" : "sourcekitten.source.lang.objc.decl.enum",
	"key.parsed_declaration" : "enum RLMError : NSInteger {}",
	"key.doc.comment" : "Enum representing all recoverable errors in Realm.",
	"key.doc.line" : 64,
	"key.name" : "RLMError",
	"key.doc.column" : 28,
	"key.parsed_scope.end" : 80,
	"key.usr" : "c:@E@RLMError",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.doc.full_as_xml" : "",
	"key.swift_declaration" : "enum RLMError : Int",
	"key.substructure" : [
	{
	"key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
	"key.parsed_declaration" : "RLMErrorFail = 1",
	"key.doc.comment" : "Returned by RLMRealm if no other specific error is returned when a realm is opened.",
	"key.doc.line" : 66,
	"key.name" : "RLMErrorFail",
	"key.doc.column" : 5,
	"key.parsed_scope.end" : 66,
	"key.usr" : "c:@E@RLMError@RLMErrorFail",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.doc.full_as_xml" : "",
	"key.swift_declaration" : "case Fail",
	"key.parsed_scope.start" : 66,
	"key.filepath" : "Realm\/RLMConstants.h"
	},
	{
	"key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
	"key.parsed_declaration" : "RLMErrorFileAccessError = 2",
	"key.doc.comment" : "Returned by RLMRealm for any I\/O related exception scenarios when a realm is opened.",
	"key.doc.line" : 68,
	"key.name" : "RLMErrorFileAccessError",
	"key.doc.column" : 5,
	"key.parsed_scope.end" : 68,
	"key.usr" : "c:@E@RLMError@RLMErrorFileAccessError",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.doc.full_as_xml" : "",
	"key.swift_declaration" : "case FileAccessError",
	"key.parsed_scope.start" : 68,
	"key.filepath" : "Realm\/RLMConstants.h"
	},
	{
	"key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
	"key.parsed_declaration" : "RLMErrorFilePermissionDenied = 3",
	"key.doc.comment" : "Returned by RLMRealm if the user does not have permission to open or create\n the specified file in the specified access mode when the realm is opened.",
	"key.doc.line" : 71,
	"key.name" : "RLMErrorFilePermissionDenied",
	"key.doc.column" : 5,
	"key.parsed_scope.end" : 71,
	"key.usr" : "c:@E@RLMError@RLMErrorFilePermissionDenied",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.doc.full_as_xml" : "",
	"key.swift_declaration" : "case FilePermissionDenied",
	"key.parsed_scope.start" : 71,
	"key.filepath" : "Realm\/RLMConstants.h"
	},
	{
	"key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
	"key.parsed_declaration" : "RLMErrorFileExists = 4",
	"key.doc.comment" : "Returned by RLMRealm if no_create was specified and the file did already exist when the realm is opened.",
	"key.doc.line" : 73,
	"key.name" : "RLMErrorFileExists",
	"key.doc.column" : 5,
	"key.parsed_scope.end" : 73,
	"key.usr" : "c:@E@RLMError@RLMErrorFileExists",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.doc.full_as_xml" : "",
	"key.swift_declaration" : "case FileExists",
	"key.parsed_scope.start" : 73,
	"key.filepath" : "Realm\/RLMConstants.h"
	},
	{
	"key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
	"key.parsed_declaration" : "RLMErrorFileNotFound = 5",
	"key.doc.comment" : "Returned by RLMRealm if no_create was specified and the file was not found when the realm is opened.",
	"key.doc.line" : 75,
	"key.name" : "RLMErrorFileNotFound",
	"key.doc.column" : 5,
	"key.parsed_scope.end" : 75,
	"key.usr" : "c:@E@RLMError@RLMErrorFileNotFound",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.doc.full_as_xml" : "",
	"key.swift_declaration" : "case FileNotFound",
	"key.parsed_scope.start" : 75,
	"key.filepath" : "Realm\/RLMConstants.h"
	},
	{
	"key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
	"key.parsed_declaration" : "RLMErrorIncompatibleLockFile = 8",
	"key.doc.comment" : "Returned by RLMRealm if the database file is currently open in another\n process which cannot share with the current process due to an\n architecture mismatch.",
	"key.doc.line" : 79,
	"key.name" : "RLMErrorIncompatibleLockFile",
	"key.doc.column" : 5,
	"key.parsed_scope.end" : 79,
	"key.usr" : "c:@E@RLMError@RLMErrorIncompatibleLockFile",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.doc.full_as_xml" : "",
	"key.swift_declaration" : "case IncompatibleLockFile",
	"key.parsed_scope.start" : 79,
	"key.filepath" : "Realm\/RLMConstants.h"
	}
	],
	"key.parsed_scope.start" : 64,
	"key.filepath" : "Realm\/RLMConstants.h"
	},
	{
	"key.kind" : "sourcekitten.source.lang.objc.decl.typedef",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.parsed_declaration" : "typedef enum RLMError RLMError",
	"key.doc.comment" : "Enum representing all recoverable errors in Realm.",
	"key.doc.full_as_xml" : "",
	"key.doc.line" : 64,
	"key.name" : "RLMError",
	"key.parsed_scope.start" : 64,
	"key.doc.column" : 28,
	"key.parsed_scope.end" : 64,
	"key.filepath" : "Realm\/RLMConstants.h",
	"key.usr" : "c:RLMConstants.h@T@RLMError"
	},

After:

SourceKitten/Tests/SourceKittenFrameworkTests/Fixtures/Realm.json

Lines 1623 to 1659 in 2e9a724

	{
	"key.filepath" : "Realm\/RLMConstants.h",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.deprecation_message" : "",
	"key.always_unavailable" : false,
	"key.unavailable_message" : "",
	"key.parsed_scope.start" : 64,
	"key.kind" : "sourcekitten.source.lang.objc.decl.typedef",
	"key.doc.full_as_xml" : "",
	"key.always_deprecated" : false,
	"key.doc.line" : 64,
	"key.doc.column" : 28,
	"key.name" : "RLMError",
	"key.doc.comment" : "Enum representing all recoverable errors in Realm.",
	"key.usr" : "c:RLMConstants.h@T@RLMError",
	"key.parsed_declaration" : "typedef enum RLMError RLMError",
	"key.parsed_scope.end" : 64
	},
	{
	"key.filepath" : "Realm\/RLMConstants.h",
	"key.doc.file" : "Realm\/RLMConstants.h",
	"key.deprecation_message" : "",
	"key.always_unavailable" : false,
	"key.unavailable_message" : "",
	"key.parsed_scope.start" : 64,
	"key.kind" : "sourcekitten.source.lang.objc.decl.enum",
	"key.swift_declaration" : "enum RLMError : Int",
	"key.doc.full_as_xml" : "",
	"key.always_deprecated" : false,
	"key.doc.line" : 64,
	"key.doc.column" : 28,
	"key.name" : "RLMError",
	"key.doc.comment" : "Enum representing all recoverable errors in Realm.",
	"key.usr" : "c:@E@RLMError",
	"key.parsed_declaration" : "enum RLMError : NSInteger {}",
	"key.parsed_scope.end" : 64
	},

@@ -1,121 +1,37 @@
         {
-          "key.kind" : "sourcekitten.source.lang.objc.decl.enum",
-          "key.parsed_declaration" : "enum RLMError : NSInteger {}",
-          "key.doc.comment" : "Enum representing all recoverable errors in Realm.",
-          "key.doc.line" : 64,
-          "key.name" : "RLMError",
-          "key.doc.column" : 28,
-          "key.parsed_scope.end" : 80,
-          "key.usr" : "c:@E@RLMError",
+          "key.filepath" : "Realm\/RLMConstants.h",
           "key.doc.file" : "Realm\/RLMConstants.h",
-          "key.doc.full_as_xml" : "",
-          "key.swift_declaration" : "enum RLMError : Int",
-          "key.substructure" : [
-            {
-              "key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
-              "key.parsed_declaration" : "RLMErrorFail = 1",
-              "key.doc.comment" : "Returned by RLMRealm if no other specific error is returned when a realm is opened.",
-              "key.doc.line" : 66,
-              "key.name" : "RLMErrorFail",
-              "key.doc.column" : 5,
-              "key.parsed_scope.end" : 66,
-              "key.usr" : "c:@E@RLMError@RLMErrorFail",
-              "key.doc.file" : "Realm\/RLMConstants.h",
-              "key.doc.full_as_xml" : "",
-              "key.swift_declaration" : "case Fail",
-              "key.parsed_scope.start" : 66,
-              "key.filepath" : "Realm\/RLMConstants.h"
-            },
-            {
-              "key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
-              "key.parsed_declaration" : "RLMErrorFileAccessError = 2",
-              "key.doc.comment" : "Returned by RLMRealm for any I\/O related exception scenarios when a realm is opened.",
-              "key.doc.line" : 68,
-              "key.name" : "RLMErrorFileAccessError",
-              "key.doc.column" : 5,
-              "key.parsed_scope.end" : 68,
-              "key.usr" : "c:@E@RLMError@RLMErrorFileAccessError",
-              "key.doc.file" : "Realm\/RLMConstants.h",
-              "key.doc.full_as_xml" : "",
-              "key.swift_declaration" : "case FileAccessError",
-              "key.parsed_scope.start" : 68,
-              "key.filepath" : "Realm\/RLMConstants.h"
-            },
-            {
-              "key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
-              "key.parsed_declaration" : "RLMErrorFilePermissionDenied = 3",
-              "key.doc.comment" : "Returned by RLMRealm if the user does not have permission to open or create\n        the specified file in the specified access mode when the realm is opened.",
-              "key.doc.line" : 71,
-              "key.name" : "RLMErrorFilePermissionDenied",
-              "key.doc.column" : 5,
-              "key.parsed_scope.end" : 71,
-              "key.usr" : "c:@E@RLMError@RLMErrorFilePermissionDenied",
-              "key.doc.file" : "Realm\/RLMConstants.h",
-              "key.doc.full_as_xml" : "",
-              "key.swift_declaration" : "case FilePermissionDenied",
-              "key.parsed_scope.start" : 71,
-              "key.filepath" : "Realm\/RLMConstants.h"
-            },
-            {
-              "key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
-              "key.parsed_declaration" : "RLMErrorFileExists = 4",
-              "key.doc.comment" : "Returned by RLMRealm if no_create was specified and the file did already exist when the realm is opened.",
-              "key.doc.line" : 73,
-              "key.name" : "RLMErrorFileExists",
-              "key.doc.column" : 5,
-              "key.parsed_scope.end" : 73,
-              "key.usr" : "c:@E@RLMError@RLMErrorFileExists",
-              "key.doc.file" : "Realm\/RLMConstants.h",
-              "key.doc.full_as_xml" : "",
-              "key.swift_declaration" : "case FileExists",
-              "key.parsed_scope.start" : 73,
-              "key.filepath" : "Realm\/RLMConstants.h"
-            },
-            {
-              "key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
-              "key.parsed_declaration" : "RLMErrorFileNotFound = 5",
-              "key.doc.comment" : "Returned by RLMRealm if no_create was specified and the file was not found when the realm is opened.",
-              "key.doc.line" : 75,
-              "key.name" : "RLMErrorFileNotFound",
-              "key.doc.column" : 5,
-              "key.parsed_scope.end" : 75,
-              "key.usr" : "c:@E@RLMError@RLMErrorFileNotFound",
-              "key.doc.file" : "Realm\/RLMConstants.h",
-              "key.doc.full_as_xml" : "",
-              "key.swift_declaration" : "case FileNotFound",
-              "key.parsed_scope.start" : 75,
-              "key.filepath" : "Realm\/RLMConstants.h"
-            },
-            {
-              "key.kind" : "sourcekitten.source.lang.objc.decl.enumcase",
-              "key.parsed_declaration" : "RLMErrorIncompatibleLockFile = 8",
-              "key.doc.comment" : "Returned by RLMRealm if the database file is currently open in another\n        process which cannot share with the current process due to an\n        architecture mismatch.",
-              "key.doc.line" : 79,
-              "key.name" : "RLMErrorIncompatibleLockFile",
-              "key.doc.column" : 5,
-              "key.parsed_scope.end" : 79,
-              "key.usr" : "c:@E@RLMError@RLMErrorIncompatibleLockFile",
-              "key.doc.file" : "Realm\/RLMConstants.h",
-              "key.doc.full_as_xml" : "",
-              "key.swift_declaration" : "case IncompatibleLockFile",
-              "key.parsed_scope.start" : 79,
-              "key.filepath" : "Realm\/RLMConstants.h"
-            }
-          ],
+          "key.deprecation_message" : "",
+          "key.always_unavailable" : false,
+          "key.unavailable_message" : "",
           "key.parsed_scope.start" : 64,
-          "key.filepath" : "Realm\/RLMConstants.h"
-        },
-        {
           "key.kind" : "sourcekitten.source.lang.objc.decl.typedef",
-          "key.doc.file" : "Realm\/RLMConstants.h",
-          "key.parsed_declaration" : "typedef enum RLMError RLMError",
-          "key.doc.comment" : "Enum representing all recoverable errors in Realm.",
           "key.doc.full_as_xml" : "",
+          "key.always_deprecated" : false,
           "key.doc.line" : 64,
+          "key.doc.column" : 28,
           "key.name" : "RLMError",
+          "key.doc.comment" : "Enum representing all recoverable errors in Realm.",
+          "key.usr" : "c:RLMConstants.h@T@RLMError",
+          "key.parsed_declaration" : "typedef enum RLMError RLMError",
+          "key.parsed_scope.end" : 64
+        },
+        {
+          "key.filepath" : "Realm\/RLMConstants.h",
+          "key.doc.file" : "Realm\/RLMConstants.h",
+          "key.deprecation_message" : "",
+          "key.always_unavailable" : false,
+          "key.unavailable_message" : "",
           "key.parsed_scope.start" : 64,
+          "key.kind" : "sourcekitten.source.lang.objc.decl.enum",
+          "key.swift_declaration" : "enum RLMError : Int",
+          "key.doc.full_as_xml" : "",
+          "key.always_deprecated" : false,
+          "key.doc.line" : 64,
           "key.doc.column" : 28,
-          "key.parsed_scope.end" : 64,
-          "key.filepath" : "Realm\/RLMConstants.h",
-          "key.usr" : "c:RLMConstants.h@T@RLMError"
+          "key.name" : "RLMError",
+          "key.doc.comment" : "Enum representing all recoverable errors in Realm.",
+          "key.usr" : "c:@E@RLMError",
+          "key.parsed_declaration" : "enum RLMError : NSInteger {}",
+          "key.parsed_scope.end" : 64
         },

This wasn't caught because these test fixtures are massive, making it very difficult to find needle-in-a-haystack regressions like these.

[jpsim]

Fixed in #305.