diff options
| author | Minh Nguyễn <mxn@1ec5.org> | 2018-03-30 05:13:33 -0700 |
|---|---|---|
| committer | Minh Nguyễn <mxn@1ec5.org> | 2018-04-02 10:42:54 -0700 |
| commit | 10440640178429fc8e5c319c86e7a3e89746952e (patch) | |
| tree | a4fac688532755c27722a35d9b99c866bc67d62e | |
| parent | 29a8efab26dfbdbe9b30b3913d397329be5edb95 (diff) | |
| download | qtlocation-mapboxgl-10440640178429fc8e5c319c86e7a3e89746952e.tar.gz | |
[ios, macos] Mention update-examples in contributing guide
| -rw-r--r-- | platform/ios/DEVELOPING.md | 2 | ||||
| -rw-r--r-- | platform/macos/DEVELOPING.md | 2 |
2 files changed, 4 insertions, 0 deletions
diff --git a/platform/ios/DEVELOPING.md b/platform/ios/DEVELOPING.md index 10a94c73f3..b45e5a0e2f 100644 --- a/platform/ios/DEVELOPING.md +++ b/platform/ios/DEVELOPING.md @@ -139,6 +139,8 @@ To add an example code listing to the documentation for a class or class member: 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 diff --git a/platform/macos/DEVELOPING.md b/platform/macos/DEVELOPING.md index 562f1291c2..bac5683266 100644 --- a/platform/macos/DEVELOPING.md +++ b/platform/macos/DEVELOPING.md @@ -117,6 +117,8 @@ To add an example code listing to the documentation for a class or class member: 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 |