Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

[ios, macos] Document DDS enumerations #7931

Merged
merged 2 commits into from
Feb 8, 2017
Merged

Conversation

boundsj
Copy link
Contributor

@boundsj boundsj commented Feb 3, 2017

Addresses enumeration todos noted in #7924

  • MGLStyleFunctionOption string enum
    • MGLStyleFunctionOptionInterpolationBase
    • MGLStyleFunctionOptionDefaultValue
  • MGLInterpolationMode enum
    • MGLInterpolationModeExponential
    • MGLInterpolationModeInterval
    • MGLInterpolationModeCategorical
    • MGLInterpolationModeIdentity

@boundsj boundsj added beta blocker Blocks the next beta release documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling labels Feb 3, 2017
@boundsj boundsj added this to the ios-v3.5.0 milestone Feb 3, 2017
@boundsj boundsj self-assigned this Feb 3, 2017
@mention-bot
Copy link

@boundsj, thanks for your PR! By analyzing this pull request, we identified @1ec5 and @friedbunny to be potential reviewers.

@boundsj boundsj force-pushed the boundsj-darwin-dds-enum-docs branch from 185c4d7 to 7e94c79 Compare February 3, 2017 04:07
@@ -6,20 +6,70 @@

NS_ASSUME_NONNULL_BEGIN

// TODO: API docs
/**
Options for `MGLStyleValue` function objects.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once #7934 is fixed, we can say these options are for MGLStyleFunction objects.

typedef NSString *MGLStyleFunctionOption NS_STRING_ENUM;

// TODO: API docs
/**
An `NSNumber` object containing an integer.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first paragraph of the comment is the abstract; the abstract should be unique within the header or class. In this case, add "that determines the style function's exponential interpolation base".

@boundsj boundsj added the ⚠️ DO NOT MERGE Work in progress, proof of concept, or on hold label Feb 7, 2017
@boundsj
Copy link
Contributor Author

boundsj commented Feb 7, 2017

068878f updates the documentation to use MGLStyleFunction. #7943 should land before this is merged.

@boundsj boundsj removed the ⚠️ DO NOT MERGE Work in progress, proof of concept, or on hold label Feb 8, 2017
@boundsj
Copy link
Contributor Author

boundsj commented Feb 8, 2017

#7943 was merged

@boundsj boundsj merged commit c639105 into master Feb 8, 2017
@boundsj boundsj deleted the boundsj-darwin-dds-enum-docs branch February 8, 2017 20:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
beta blocker Blocks the next beta release documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS runtime styling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants