Skip to content

Loading…

Update docs/syntax/index.mustache #115

Merged
merged 1 commit into from

2 participants

@prodaea

Updated crosslink documentation to match this ticket's impact on additional functionality.

#58

@prodaea prodaea Update docs/syntax/index.mustache
Updated crosslink documentation to match this ticket's impact on additional functionality.

yui#58
eabff7c
@davglass davglass merged commit a1eef4d into yui:master

1 check failed

Details default The Travis build failed
@davglass
YUI Library member

Thanks!

@prodaea

Yeah! NP, love that functionality but wouldn't have found it if it wasn't for that google thing. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 17, 2013
  1. @prodaea

    Update docs/syntax/index.mustache

    prodaea committed
    Updated crosslink documentation to match this ticket's impact on additional functionality.
    
    yui#58
This page is out of date. Refresh to see the latest.
Showing with 15 additions and 2 deletions.
  1. +15 −2 docs/syntax/index.mustache
View
17 docs/syntax/index.mustache
@@ -1199,13 +1199,26 @@ This is what the above would render to:
<h3>Cross-referencing Modules and Classes</h3>
<p>YUIDoc also includes a Handlebars `blockHelper` that enables you to
-easily cross-reference classes and modules. For example, if you include:</p>
+easily cross-reference classes and modules. It uses this pattern:
+</p>
+
+```
+#crossLink "Class/item:type"
+
+#crossLink "Foo/bar:event"
+#crossLink "Foo/bar:attribute"
+#crossLink "Foo/bar:method" --default
+```
+
+<p>
+So, for example, if you include:
+</p>
```
/**
This module also uses \{{#crossLink "Foo"}}\{{/crossLink}}, where Foo is a class name.
-Also see \{{#crossLink "myClass/Foo"}}\{{/crossLink}}, where myClass is a class name and Foo is a method on that class.
+Also see \{{#crossLink "myClass/Foo:method"}}\{{/crossLink}}, where myClass is a class name and Foo is a method on that class.
This module uses \{{#crossLinkModule "widget"}}\{{/crossLinkModule}}, where widget is a module name
Something went wrong with that request. Please try again.