aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorIgor Minar2010-11-17 12:52:45 -0800
committerIgor Minar2010-11-18 02:34:53 -0800
commitdd687e2bf565c48d00e47f9af666cee4a2b9abd9 (patch)
tree8977ef08745282aa86f5c65a93b2ce26a0e4e8fd /docs
parent4c69d694d75f01cffbc75be331b5636068a41048 (diff)
downloadangular.js-dd687e2bf565c48d00e47f9af666cee4a2b9abd9.tar.bz2
@returns description should support markdown
Diffstat (limited to 'docs')
-rw-r--r--docs/collect.js2
-rw-r--r--docs/spec/collectSpec.js5
2 files changed, 6 insertions, 1 deletions
diff --git a/docs/collect.js b/docs/collect.js
index 2cb85fe2..d9556747 100644
--- a/docs/collect.js
+++ b/docs/collect.js
@@ -213,7 +213,7 @@ function returnsTag(doc, name, value) {
if (match) {
var tag = {
type: match[1],
- description: match[2] || false
+ description: markdownNoP(match[2]) || false
};
} else {
throw "[" + doc.raw.file + ":" + doc.raw.line +
diff --git a/docs/spec/collectSpec.js b/docs/spec/collectSpec.js
index 7777e8f4..b61097f6 100644
--- a/docs/spec/collectSpec.js
+++ b/docs/spec/collectSpec.js
@@ -170,6 +170,11 @@ describe('collect', function(){
TAG.returns(doc, 'returns', '{string} descrip tion');
expect(doc.returns).toEqual({type: 'string', description: 'descrip tion'});
});
+
+ it('should transform description of @returns with markdown', function() {
+ TAG.returns(doc, 'returns', '{string} descrip *tion*');
+ expect(doc.returns).toEqual({type: 'string', description: 'descrip <em>tion</em>'});
+ });
});
describe('@description', function(){