[ios, macos] Mention update-examples in contributing guide

This commit is contained in:
Minh Nguyễn
2018-03-30 05:13:33 -07:00
committed by Minh Nguyễn
parent 29a8efab26
commit 1044064017
2 changed files with 4 additions and 0 deletions

View File

@@ -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

View File

@@ -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