From 10440640178429fc8e5c319c86e7a3e89746952e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Minh=20Nguye=CC=82=CC=83n?= Date: Fri, 30 Mar 2018 05:13:33 -0700 Subject: [ios, macos] Mention update-examples in contributing guide --- platform/ios/DEVELOPING.md | 2 ++ platform/macos/DEVELOPING.md | 2 ++ 2 files changed, 4 insertions(+) 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 -- cgit v1.2.1