react-native/React/Base
Teddy Martin ca898f4367 Add docs for Swift usage to RCTBridgeModule.h
Summary:
Clarifies how to get a reference to RCTBridge from a Swift RCTBridgeModule.

<!--
Thank you for sending the PR! We appreciate you spending the time to work on these changes.

Help us understand your motivation by explaining why you decided to make this change.

You can learn more about contributing to React Native here: http://facebook.github.io/react-native/docs/contributing.html

Happy contributing!

-->

In writing native modules for Swift, I have run into issues where the documentation applies only to Objective-C and does not supply adequate information for how one might accomplish something in Swift.

This is a good example, where the `synthesize` method simply does not apply to Swift code.

[IOS][ENHANCEMENT][Base/RCTBridgeModule.h] Add documentation for Swift usage.
<!--
Help reviewers and the release process by writing your own release notes

**INTERNAL and MINOR tagged notes will not be included in the next version's final release notes.**

  CATEGORY
[----------]        TYPE
[ CLI      ]   [-------------]      LOCATION
[ DOCS     ]   [ BREAKING    ]   [-------------]
[ GENERAL  ]   [ BUGFIX      ]   [-{Component}-]
[ INTERNAL ]   [ ENHANCEMENT ]   [ {File}      ]
[ IOS      ]   [ FEATURE     ]   [ {Directory} ]   |-----------|
[ ANDROID  ]   [ MINOR       ]   [ {Framework} ] - | {Message} |
[----------]   [-------------]   [-------------]   |-----------|

[CATEGORY] [TYPE] [LOCATION] - MESSAGE

 EXAMPLES:

 [IOS] [BREAKING] [FlatList] - Change a thing that breaks other things
 [ANDROID] [BUGFIX] [TextInput] - Did a thing to TextInput
 [CLI] [FEATURE] [local-cli/info/info.js] - CLI easier to do things with
 [DOCS] [BUGFIX] [GettingStarted.md] - Accidentally a thing/word
 [GENERAL] [ENHANCEMENT] [Yoga] - Added new yoga thing/position
 [INTERNAL] [FEATURE] [./scripts] - Added thing to script that nobody will see
-->
Closes https://github.com/facebook/react-native/pull/18231

Differential Revision: D7262850

Pulled By: hramos

fbshipit-source-id: c6babb3edd786be8571eb49258d594f2fb99141d
2018-03-13 15:22:01 -07:00
..
Surface iOS Surface: properly reset some internal states when JS reloads 2018-03-07 10:45:14 -08:00
RCTAssert.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTAssert.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTBridge+Private.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTBridge.h Add `RCTJavaScriptWillStartExecutingNotification` 2018-03-06 11:05:25 -08:00
RCTBridge.m Add `RCTJavaScriptWillStartExecutingNotification` 2018-03-06 11:05:25 -08:00
RCTBridgeDelegate.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTBridgeMethod.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTBridgeModule.h Add docs for Swift usage to RCTBridgeModule.h 2018-03-13 15:22:01 -07:00
RCTBundleURLProvider.h Wrap global variables in extern C 2018-03-02 19:44:18 -08:00
RCTBundleURLProvider.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTConvert.h Mark ObjC methods that are called from React Native as dynamic. 2018-02-26 12:24:17 -08:00
RCTConvert.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTCxxConvert.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTCxxConvert.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTDefines.h Mark ObjC methods that are called from React Native as dynamic. 2018-02-26 12:24:17 -08:00
RCTDisplayLink.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTDisplayLink.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTErrorCustomizer.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTErrorInfo.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTErrorInfo.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTEventDispatcher.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTEventDispatcher.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTFrameUpdate.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTFrameUpdate.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTImageSource.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTImageSource.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTInvalidating.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTJSCErrorHandling.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTJSCErrorHandling.mm Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTJSStackFrame.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTJSStackFrame.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTJavaScriptExecutor.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTJavaScriptLoader.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTJavaScriptLoader.mm Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTKeyCommands.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTKeyCommands.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTLog.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTLog.mm Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTManagedPointer.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTManagedPointer.mm Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTModuleData.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTModuleData.mm Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTModuleMethod.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTModuleMethod.mm Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTMultipartDataTask.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTMultipartDataTask.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTMultipartStreamReader.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTMultipartStreamReader.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTNullability.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTParserUtils.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTParserUtils.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTPerformanceLogger.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTPerformanceLogger.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTPlatform.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTPlatform.m Expose React Native version as a symbol rather than macro 2018-03-02 14:51:39 -08:00
RCTReloadCommand.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTReloadCommand.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTRootContentView.h iOS: branch out Fabric handling into a separate RCTSurface-compatible class. 2018-03-05 18:57:30 -08:00
RCTRootContentView.m iOS: branch out Fabric handling into a separate RCTSurface-compatible class. 2018-03-05 18:57:30 -08:00
RCTRootView.h iOS: branch out Fabric handling into a separate RCTSurface-compatible class. 2018-03-05 18:57:30 -08:00
RCTRootView.m iOS: branch out Fabric handling into a separate RCTSurface-compatible class. 2018-03-05 18:57:30 -08:00
RCTRootViewDelegate.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTRootViewInternal.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTTVRemoteHandler.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTTVRemoteHandler.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTTouchEvent.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTTouchEvent.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTTouchHandler.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTTouchHandler.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTURLRequestDelegate.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTURLRequestHandler.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTUtils.h Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTUtils.m Update license headers for MIT license 2018-02-16 18:31:53 -08:00
RCTVersion.h Expose React Native version as a symbol rather than macro 2018-03-02 14:51:39 -08:00
RCTVersion.m Expose React Native version as a symbol rather than macro 2018-03-02 14:51:39 -08:00