summaryrefslogtreecommitdiff
path: root/platform/ios/DEVELOPING.md
diff options
context:
space:
mode:
authorJosh Erb <josh.erb@mapbox.com>2019-01-11 15:15:22 -0500
committerJason Wray <friedbunny@users.noreply.github.com>2019-01-25 12:05:56 -0800
commit3501025c144388ddbb4177c27530e8721ff9bdcb (patch)
treeef7d6179381ee6f6fdc34bf9766f2ed873a02884 /platform/ios/DEVELOPING.md
parent984a5ccd5b4b060611c64f58d91506c3e2b5022a (diff)
downloadqtlocation-mapboxgl-3501025c144388ddbb4177c27530e8721ff9bdcb.tar.gz
[ios][docs] update code snippet instructions
Diffstat (limited to 'platform/ios/DEVELOPING.md')
-rw-r--r--platform/ios/DEVELOPING.md23
1 files changed, 12 insertions, 11 deletions
diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md
index 8dabc98a6f..7b34c84386 100644
--- a/platform/ios/DEVELOPING.md
+++ b/platform/ios/DEVELOPING.md
@@ -125,17 +125,18 @@ find platform/{darwin,ios}/resources platform/macos/sdk -path '*/MYLANG.lproj/*.
To add an example code listing to the documentation for a class or class member:
-1. Add a test method named in the form `testMGLClass` or `testMGLClass$method`
- to [MGLDocumentationExampleTests](test/MGLDocumentationExampleTests.swift).
- Wrap the code you’d like to appear in the documentation within
- `//#-example-code` and `//#-end-example-code` comments.
-1. If the header doesn’t already have an example code listing, add the path to
- the header to platform/darwin/scripts/update-examples.list.
-1. Insert the code listings into the headers:
-
-```bash
-make darwin-update-examples
-```
+ 1. Add a test case named in the form testMGLClass or testMGLClass$method to [MGLDocumentationExamplesTests](test/MGLDocumentationExampleTests.swift).
+ 2. Wrap the code you'd like to appear in the documentation within the
+ following comment blocks:
+ ```
+ //#-example-code
+ ...
+ //#-end-example-code
+ ```
+ 3. Insert an empty Swift code block inside the header file where you'd like the
+ example code to be inserted.
+ 4. Run `make darwin-update-examples` to extract example code from the test
+ method below and insert it into the header.
[SourceKitten](https://github.com/jpsim/SourceKitten/) is required and will be installed automatically using Homebrew.