diff options
| author | Konstantin Käfer <mail@kkaefer.com> | 2017-01-03 16:17:04 +0100 |
|---|---|---|
| committer | Konstantin Käfer <mail@kkaefer.com> | 2017-01-04 23:06:22 +0100 |
| commit | b515762528ce1b14b23fc7c445dc9c8702ac6600 (patch) | |
| tree | 693802cb259b8cc203a91e769d57839b508411cb /platform | |
| parent | b981c5268221f0f1e2d454a674325081869e28ab (diff) | |
| download | qtlocation-mapboxgl-b515762528ce1b14b23fc7c445dc9c8702ac6600.tar.gz | |
[docs] Add note about MGL_EXPORT to macOS documentation
Diffstat (limited to 'platform')
| -rw-r--r-- | platform/ios/DEVELOPING.md | 1 | ||||
| -rw-r--r-- | platform/macos/DEVELOPING.md | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md index 94ff49ee1b..22635be264 100644 --- a/platform/ios/DEVELOPING.md +++ b/platform/ios/DEVELOPING.md @@ -77,6 +77,7 @@ To add any Objective-C type, constant, or member to the iOS SDK’s public inter To add an Objective-C class, protocol, category, typedef, enumeration, or global constant to the iOS SDK’s public interface: +1. _(Optional.)_ Add the macro `MGL_EXPORT` prior to the declaration for classes and global constants when adding them in shared headers located in `platform/darwin`. To use this macro, include `MGLFoundation.h`. You can check whether all public symbols are exported correctly by running `make check-public-symbols`. 1. _(Optional.)_ Add the type or constant’s name to the relevant category in the `custom_categories` section of [the jazzy configuration file](./jazzy.yml). This is required for classes and protocols and also recommended for any other type that is strongly associated with a particular class or protocol. If you leave out this step, the symbol will appear in an “Other” section in the generated HTML documentation’s table of contents. 1. _(Optional.)_ If the symbol would also be publicly exposed in the macOS SDK, consult [the companion macOS document](../macos/DEVELOPING.md#making-a-type-or-constant-public) for further instructions. diff --git a/platform/macos/DEVELOPING.md b/platform/macos/DEVELOPING.md index 71eb7995c8..c8e064fbed 100644 --- a/platform/macos/DEVELOPING.md +++ b/platform/macos/DEVELOPING.md @@ -54,6 +54,7 @@ To add any Objective-C type, constant, or member to the iOS SDK’s public inter To add an Objective-C class, protocol, category, typedef, enumeration, or global constant to the macOS SDK’s public interface: +1. _(Optional.)_ Add the macro `MGL_EXPORT` prior to the declaration for classes and global constants. To use this macro, include `MGLFoundation.h`. You can check whether all public symbols are exported correctly by running `make check-public-symbols`. 1. _(Optional.)_ Add the type or constant’s name to the relevant category in the `custom_categories` section of [the jazzy configuration file](./jazzy.yml). This is required for classes and protocols and also recommended for any other type that is strongly associated with a particular class or protocol. If you leave out this step, the symbol will appear in an “Other” section in the generated HTML documentation’s table of contents. 1. _(Optional.)_ If the symbol would also be publicly exposed in the iOS SDK, consult [the companion iOS document](../ios/DEVELOPING.md#making-a-type-or-constant-public) for further instructions. |