short
\nmed
\nlong\nline
\nfn with optional arguments
\ntext bold.
\n, but escape the html escape the content', function() {
- expect(new Doc().markdown('bah x\n\nangular.k\n
\n asdf x')).
- toEqual(
- 'bah x\n' +
- '
\n' +
- '<b>angular</b>.k\n' +
- '
\n' +
- ' asdf x\n');
- });
-
- it('should wrap everything inside a container tag', function() {
- var doc = new Doc('@name superman').parse();
- var content = doc.markdown('hello');
-
- expect(content).toMatch('hello
\n');
- });
-
- it('should use the content before a colon as the name prefix for the className of the tag container', function() {
- var doc = new Doc('@name super: man').parse();
- var content = doc.markdown('hello');
-
- expect(content).toMatch('hello
\n');
- });
-
- it('should replace text between two tags', function() {
- expect(new Doc().markdown('x
\n# One\nb
')).
- toMatch('\nbefore
\nfirst line\n' + - 'second line
\n' + - 'third line\n' +
- ' fourth linefifth line
\n'); - }); - - it('should unindent text before processing based on the first line', function() { - expect(new Doc().markdown(' first line\n\n' + - ' second line\n' + - ' third line\n' + - ' fourth line\n\n' + - ' fifth line')). - toMatch('first line
\n' + - 'second line\n' +
- 'third line\n' +
- ' fourth linefifth line
\n\n//!annotate supertext\n" - ) - ).toContain('data-popover data-content="supertext"') - }); - - it('should allow for a custom regular expression for matching', function() { - expect(new Doc().markdown( - "
\n
\n//!annotate=\"soon\" supertext\n" - ) - ).toContain('data-popover data-content="supertext" data-title="Info">soon') - }); - - it('should allow for a custom title to be set', function() { - expect(new Doc().markdown( - "soon
\n
\n//!annotate=\"soon\" coming soon|supertext\n" - ) - ).toContain('data-popover data-content="supertext" data-title="coming soon">soon') - }); - }); - }); - - describe('trim', function() { - var trim = ngdoc.trim; - it('should remove leading/trailing space', function() { - expect(trim(' \nabc\n ')).toEqual('abc'); - }); - - it('should remove leading space on every line', function() { - expect(trim('\n 1\n 2\n 3\n')).toEqual('1\n 2\n 3'); - }); - }); - - describe('merge', function() { - it('should merge child with parent', function() { - var parent = new Doc({id: 'ng.abc', name: 'ng.abc', section: 'api'}); - var methodA = new Doc({name: 'methodA', methodOf: 'ng.abc'}); - var methodB = new Doc({name: 'methodB', methodOf: 'ng.abc'}); - var propA = new Doc({name: 'propA', propertyOf: 'ng.abc'}); - var propB = new Doc({name: 'propB', propertyOf: 'ng.abc'}); - var eventA = new Doc({name: 'eventA', eventOf: 'ng.abc'}); - var eventB = new Doc({name: 'eventB', eventOf: 'ng.abc'}); - var docs = [methodB, methodA, eventB, eventA, propA, propB, parent]; // keep wrong order; - ngdoc.merge(docs); - expect(docs.length).toEqual(1); - expect(docs[0].id).toEqual('ng.abc'); - expect(docs[0].methods).toEqual([methodA, methodB]); - expect(docs[0].events).toEqual([eventA, eventB]); - expect(docs[0].properties).toEqual([propA, propB]); - }); - }); - - - describe('checkBrokenLinks', function() { - var docs; - - beforeEach(function() { - spyOn(console, 'log'); - docs = [new Doc({section: 'api', id: 'fake.id1', anchors: ['one']}), - new Doc({section: 'api', id: 'fake.id2'}), - new Doc({section: 'api', id: 'fake.id3'})]; - }); - - it('should log warning when a linked page does not exist', function() { - docs.push(new Doc({section: 'api', id: 'with-broken.link', links: ['non-existing-link']})) - ngdoc.checkBrokenLinks(docs); - expect(console.log).toHaveBeenCalled(); - var warningMsg = console.log.argsForCall[0][0] - expect(warningMsg).toContain('WARNING:'); - expect(warningMsg).toContain('non-existing-link'); - expect(warningMsg).toContain('api/with-broken.link'); - }); - - it('should log warning when a linked anchor does not exist', function() { - docs.push(new Doc({section: 'api', id: 'with-broken.link', links: ['api/fake.id1#non-existing']})) - ngdoc.checkBrokenLinks(docs); - expect(console.log).toHaveBeenCalled(); - var warningMsg = console.log.argsForCall[0][0] - expect(warningMsg).toContain('WARNING:'); - expect(warningMsg).toContain('non-existing'); - expect(warningMsg).toContain('api/with-broken.link'); - }); - }); - - - describe('api section', function() { - - it('should render a "view source" button with link to the source in master', function() { - var doc = new Doc({ - id: 'ng.abc', - name: 'ng.abc', - section: 'api', - ngdoc: 'service', - file: 'fooService.js', - line: '333' - }); - - if (gruntUtil.getVersion().full.indexOf('-') === -1) { - expect(doc.html().match(/^()/)[1]).toMatch( - /soon
\n
Number \nto format.
\n' }]); - }); - - it('should parse with default and optional', function() { - var doc = new Doc('@name a\n@param {(number|string)=} [fractionSize=2] desc'); - doc.parse(); - expect(doc.param).toEqual([{ - type : '(number|string)', - name : 'fractionSize', - optional: true, - 'default' : '2', - description : 'desc
\nfor \nA
for B
for \nA
for B
desc rip tion
\ndesc rip tion
\ndescrip tion
\ndescription
\ndescrip tion
\ndescription\nnew line\nanother line
\nabc"); - doc.parse(); - expect(doc.description). - toBe('
<b>abc</b>\n
abc\n#bah\nfoo \n
cba"); - doc.parse(); - expect(doc.description). - toBe('
foo \n' + - '
abc\n' + - '
foo \n' + - '
cba\n
angular.foo');
- expect(doc.description).
- toContain('da bar foo bar');
- expect(doc.description).
- toContain('dadangular.foo');
- expect(doc.description).
- toContain('ng:foo');
- expect(doc.description).
- toContain('http://angularjs.org');
- expect(doc.description).
- toContain('./static.html');
- });
-
- it('should support line breaks in @link', function() {
- var doc = new Doc("@name a\n@description " +
- '{@link\napi/angular.foo\na\nb}');
- doc.parse();
- expect(doc.description).
- toContain('a b');
- });
-
- });
-
- describe('@example', function() {
- it('should not remove {{}}', function() {
- var doc = new Doc('@name a\n@example text {{ abc }}');
- doc.parse();
- expect(doc.example).toEqual('text {{ abc }}
\nthisI am self.
\n' + - 'thisI am self.
\n