Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Fix the usage documentation of linky #1186

Closed
wants to merge 2 commits into from
Closed

Fix the usage documentation of linky #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68f26c4
chore(ngDoc): add support for custom @Usage metadata
btford Jul 19, 2012
56fb193
fix(docs): fixed documentation for using linky
btford Jul 19, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions docs/src/ngdoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,12 +451,16 @@ Doc.prototype = {
dom.h('Usage', function() {
dom.h('In HTML Template Binding', function() {
dom.tag('code', function() {
dom.text('{{ ');
dom.text(self.shortName);
dom.text('_expression | ');
dom.text(self.shortName);
self.parameters(dom, ':', true);
dom.text(' }}');
if (self.usage) {
dom.text(self.usage);
} else {
dom.text('{{ ');
dom.text(self.shortName);
dom.text('_expression | ');
dom.text(self.shortName);
self.parameters(dom, ':', true);
dom.text(' }}');
}
});
});

Expand Down
3 changes: 3 additions & 0 deletions src/ngSanitize/filter/linky.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
* @param {string} text Input text.
* @returns {string} Html-linkified text.
*
* @usage
<span ng-bind-html="linky_expression | linky"></span>
*
* @example
<doc:example module="ngSanitize">
<doc:source>
Expand Down