archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #540 from ThyBzi/master

Browse Source 
Automatically remove per-line indent for @example tag
This commit is contained in:
Jeff Williams 2013-11-26 14:21:54 -08:00
commit f3d484f785
3 changed files with 37 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lib/jsdoc/tag.js
View File

@ -22,11 +22,19 @@ var jsdoc = {
}
};
function trim(text, newlines) {
function trim(text, newlines, outdent) {
if (!text) { return ''; }
if (newlines) {
return text.replace(/^[\n\r\f]+|[\n\r\f]+$/g, '');
text = text.replace(/^[\n\r\f]+|[\n\r\f]+$/g, '');
if (outdent) {
var match = text.match(/^([ \t]+)/);
if (match && match[1]) {
var outdenter = new RegExp('^' + match[1], 'gm');
text = text.replace(outdenter, '');
}
}
return text;
}
else {
return text.replace(/^\s+|\s+$/g, '');
@ -94,7 +102,7 @@ var Tag = exports.Tag = function(tagTitle, tagBody, meta) {
var tagDef = jsdoc.tag.dictionary.lookUp(this.title);
/** The text part of the tag: @title text */
this.text = trim(tagBody, tagDef.keepsWhitespace);
this.text = trim(tagBody, tagDef.keepsWhitespace, tagDef.removesIndent);
if (this.text) {
processTagText(this, tagDef);

1
lib/jsdoc/tag/dictionary/definitions.js
View File

@ -297,6 +297,7 @@ exports.defineTags = function(dictionary) {
dictionary.defineTag('example', {
keepsWhitespace: true,
removesIndent: true,
mustHaveValue: true,
onTagged: function(doclet, tag) {
if (!doclet.examples) { doclet.examples = []; }

30
test/specs/jsdoc/tag.js
View File

@ -25,7 +25,7 @@ describe("jsdoc/tag", function() {
' * myFunction(3, 4); // returns 7\n';
var tagArg = new jsdoc.tag.Tag('arg ', text, meta), // <-- a symonym of param, space in the title.
tagParam = new jsdoc.tag.Tag('param', '[foo=1]', meta), // no type, but has optional and defaultvalue.
tagEg = new jsdoc.tag.Tag('example', textEg, meta), // <-- for keepsWhitespace
tagEg = new jsdoc.tag.Tag('example', textEg, meta), // <-- for keepsWhitespace and removesIndent
tagType = new jsdoc.tag.Tag('type', 'MyType ', meta); // <-- for onTagText
it("should have a 'originalTitle' property, a string", function() {
@ -60,11 +60,31 @@ describe("jsdoc/tag", function() {
});
describe("'text' property", function() {
function trim(text, newlines, outdent) {
if (!text) { return ''; }
if (newlines) {
text = text.replace(/^[\n\r\f]+|[\n\r\f]+$/g, '');
if (outdent) {
var match = text.match(/^([ \t]+)/);
if (match && match[1]) {
var outdenter = new RegExp('^' + match[1], 'gm');
text = text.replace(outdenter, '');
}
}
return text;
}
else {
return text.replace(/^\s+|\s+$/g, '');
}
}
it("'text' property should be the trimmed tag text, with all leading and trailing space removed unless tagDef.keepsWhitespace", function() {
// @example has keepsWhitespace, @param doesn't.
// should realy use module:jsdoc/tag~trim here but it's private.
expect(tagArg.text).toBe(text.replace(/^\s+|\s+$/g, ''));
expect(tagEg.text).toBe(textEg.replace(/^[\n\r\f]+|[\n\r\f]+$/g, ''));
// @example has keepsWhitespace and removesIndent, @param doesn't.
// should realy use module:jsdoc/tag~trim here but it's private, so the function is copied locally.
expect(tagArg.text).toBe(trim(text));
expect(tagEg.text).toBe(trim(textEg, true, true));
});
it("'text' property should have onTagText run on it if it has it.", function() {