From 762f8c2e5a74f060c7985bb46565ec2e38862bbe Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Fri, 22 Aug 2014 14:17:59 -0700 Subject: [PATCH] :memo: Update Syntax docs --- src/syntax.coffee | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/syntax.coffee b/src/syntax.coffee index 9756a0d5e..e4ab7de03 100644 --- a/src/syntax.coffee +++ b/src/syntax.coffee @@ -14,7 +14,7 @@ Token = require './token' # An instance of this class is always available as the `atom.syntax` global. # # The Syntax class also contains properties for things such as the -# language-specific comment regexes. +# language-specific comment regexes. See {::getProperty} for more details. module.exports = class Syntax extends GrammarRegistry PropertyAccessors.includeInto(this) @@ -55,14 +55,15 @@ class Syntax extends GrammarRegistry # Public: Get a property for the given scope and key path. # - # ## Example + # ## Examples + # # ```coffee # comment = atom.syntax.getProperty(['.source.ruby'], 'editor.commentStart') # console.log(comment) # '# ' # ``` # - # scope - An {Array} of {String} scopes. - # keyPath - A {String} key path. + # * `scope` An {Array} of {String} scopes. + # * `keyPath` A {String} key path. # # Returns a {String} property value or undefined. getProperty: (scope, keyPath) ->