diff options
| author | Jason Molenda <jmolenda@apple.com> | 2016-12-13 05:59:24 +0000 |
|---|---|---|
| committer | Jason Molenda <jmolenda@apple.com> | 2016-12-13 05:59:24 +0000 |
| commit | 6546b9a209603f1b598f41d4db8264921d78b576 (patch) | |
| tree | 9c1acfd5d2933c58d948227986b705a4a0159516 /lldb/docs/structured_data | |
| parent | 463bebc319b7ef73e45d447e0903481528fb44df (diff) | |
| download | bcm5719-llvm-6546b9a209603f1b598f41d4db8264921d78b576.tar.gz bcm5719-llvm-6546b9a209603f1b598f41d4db8264921d78b576.zip | |
Small tweaks to the markup in StructuredDataPlugins.
llvm-svn: 289520
Diffstat (limited to 'lldb/docs/structured_data')
| -rw-r--r-- | lldb/docs/structured_data/StructuredDataPlugins.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/lldb/docs/structured_data/StructuredDataPlugins.md b/lldb/docs/structured_data/StructuredDataPlugins.md index bd4d6bea130..2a536c7871b 100644 --- a/lldb/docs/structured_data/StructuredDataPlugins.md +++ b/lldb/docs/structured_data/StructuredDataPlugins.md @@ -3,7 +3,7 @@ ## Overview This document describes an infrastructural feature called Structured -Data plugins. See the DarwinLog.md doc for a description of one +Data plugins. See the `DarwinLog.md` doc for a description of one such plugin that makes use of this feature. ## StructuredDataPlugin @@ -39,7 +39,7 @@ StructuredDataPlugin instances have the following characteristics: const StructuredData::ObjectSP &config_sp) ``` - where type_name is the feature name and config_sp points to the + where `type_name` is the feature name and `config_sp` points to the configuration structured data, which may be nullptr. * Plugins for features present in a process are notified when modules @@ -99,7 +99,7 @@ StructuredDataPlugin instances have the following characteristics: &supported_type_names) ``` - The supported_type_names specifies an array of string entries, + The `supported_type_names` specifies an array of string entries, where each entry specifies the name of a StructuredData feature. * Provide a way to forward on configuration data for a feature type @@ -129,8 +129,8 @@ StructuredDataPlugin instances have the following characteristics: previously advertised. Everything else about the content of the dictionary is entirely up to the feature. -* StructuredDataPlugin commands show up under 'plugin structured-data - plugin-name'. +* StructuredDataPlugin commands show up under `plugin structured-data + plugin-name`. * StructuredDataPlugin settings show up under - 'plugin.structured-data.{plugin-name}. + `plugin.structured-data.{plugin-name}`. |
