[ios, macos] Don't add documentation to NS_ENUM

mapbox · Feb 9, 2017 · c602839 · c602839
1 parent 77dce27
commit c602839
Show file tree

Hide file tree

Showing 7 changed files with 721 additions and 1,105 deletions.
diff --git a/platform/darwin/scripts/generate-style-code.js b/platform/darwin/scripts/generate-style-code.js
@@ -280,29 +280,29 @@ global.propertyDoc = function (propertyName, property, layerType, kind) {
  }
  doc += `\n\nThis attribute corresponds to the <a href="https://www.mapbox.com/mapbox-gl-style-spec/#${anchor}"><code>${property.original}</code></a> layout property in the Mapbox Style Specification.`;
  }
- }
- doc += '\n\nThis property can be set to one of the following values:\n\n' +
- '- `MGLStyleConstantValue`\n';
- if (property["property-function"]) {
- doc += '- `MGLCameraStyleFunction` with an interpolation mode of:\n' +
- ' - `MGLInterpolationModeExponential`\n' +
- ' - `MGLInterpolationModeInterval`\n' +
- '- `MGLSourceStyleFunction` with an interpolation mode of:\n' +
- ' - `MGLInterpolationModeExponential`\n' +
- ' - `MGLInterpolationModeInterval`\n' +
- ' - `MGLInterpolationModeCategorical`\n' +
- ' - `MGLInterpolationModeIdentity`\n' +
- '- `MGLCompositeStyleFunction` with an interpolation mode of:\n' +
- ' - `MGLInterpolationModeExponential`\n' +
- ' - `MGLInterpolationModeInterval`\n' +
- ' - `MGLInterpolationModeCategorical`\n';
- } else {
- if (property.function === "interpolated") {
- doc += '- `MGLCameraStyleFunction` with an interpolation mode of:\n' +
- ' - `MGLInterpolationModeExponential`\n' +
- ' - `MGLInterpolationModeInterval`\n';
+ doc += '\n\nYou can set this property to an instance of:\n\n' +
+ '* `MGLStyleConstantValue`\n';
+ if (property["property-function"]) {
+ doc += '* `MGLCameraStyleFunction` with an interpolation mode of:\n' +
+ ' * `MGLInterpolationModeExponential`\n' +
+ ' * `MGLInterpolationModeInterval`\n' +
+ '* `MGLSourceStyleFunction` with an interpolation mode of:\n' +
+ ' * `MGLInterpolationModeExponential`\n' +
+ ' * `MGLInterpolationModeInterval`\n' +
+ ' * `MGLInterpolationModeCategorical`\n' +
+ ' * `MGLInterpolationModeIdentity`\n' +
+ '* `MGLCompositeStyleFunction` with an interpolation mode of:\n' +
+ ' * `MGLInterpolationModeExponential`\n' +
+ ' * `MGLInterpolationModeInterval`\n' +
+ ' * `MGLInterpolationModeCategorical`\n';
  } else {
- doc += '- `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval`\n';
+ if (property.function === "interpolated") {
+ doc += '* `MGLCameraStyleFunction` with an interpolation mode of:\n' +
+ ' * `MGLInterpolationModeExponential`\n' +
+ ' * `MGLInterpolationModeInterval`\n';
+ } else {
+ doc += '* `MGLCameraStyleFunction` with an interpolation mode of `MGLInterpolationModeInterval`\n';
+ }
  }
  }
  return doc;

diff --git a/platform/darwin/src/MGLBackgroundStyleLayer.h b/platform/darwin/src/MGLBackgroundStyleLayer.h
@@ -39,12 +39,12 @@ MGL_EXPORT
  This property is only applied to the style if `backgroundPattern` is set to
  `nil`. Otherwise, it is ignored.
  
- This property can be set to one of the following values:
+ You can set this property to an instance of:
  
- - `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of:
- - `MGLInterpolationModeExponential`
- - `MGLInterpolationModeInterval`
+ * `MGLStyleConstantValue`
+ * `MGLCameraStyleFunction` with an interpolation mode of:
+ * `MGLInterpolationModeExponential`
+ * `MGLInterpolationModeInterval`
  */
 @property (nonatomic, null_resettable) MGLStyleValue<UIColor *> *backgroundColor;
 #else
@@ -58,12 +58,12 @@ MGL_EXPORT
  This property is only applied to the style if `backgroundPattern` is set to
  `nil`. Otherwise, it is ignored.
  
- This property can be set to one of the following values:
+ You can set this property to an instance of:
  
- - `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of:
- - `MGLInterpolationModeExponential`
- - `MGLInterpolationModeInterval`
+ * `MGLStyleConstantValue`
+ * `MGLCameraStyleFunction` with an interpolation mode of:
+ * `MGLInterpolationModeExponential`
+ * `MGLInterpolationModeInterval`
  */
 @property (nonatomic, null_resettable) MGLStyleValue<NSColor *> *backgroundColor;
 #endif
@@ -75,12 +75,12 @@ MGL_EXPORT
  `NSNumber` object containing the float `1`. Set this property to `nil` to reset
  it to the default value.
  
- This property can be set to one of the following values:
+ You can set this property to an instance of:
  
- - `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of:
- - `MGLInterpolationModeExponential`
- - `MGLInterpolationModeInterval`
+ * `MGLStyleConstantValue`
+ * `MGLCameraStyleFunction` with an interpolation mode of:
+ * `MGLInterpolationModeExponential`
+ * `MGLInterpolationModeInterval`
  */
 @property (nonatomic, null_resettable) MGLStyleValue<NSNumber *> *backgroundOpacity;
 
@@ -89,10 +89,10 @@ MGL_EXPORT
  seamless patterns, image width and height must be a factor of two (2, 4, 8,
  ..., 512).
  
- This property can be set to one of the following values:
+ You can set this property to an instance of:
  
- - `MGLStyleConstantValue`
- - `MGLCameraStyleFunction` with an interpolation mode of
+ * `MGLStyleConstantValue`
+ * `MGLCameraStyleFunction` with an interpolation mode of
  `MGLInterpolationModeInterval`
  */
 @property (nonatomic, null_resettable) MGLStyleValue<NSString *> *backgroundPattern;