aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJulien Bouquillon2013-05-10 23:06:18 +0200
committerBrian Ford2013-07-11 14:40:06 -0700
commit61fb5863df4afe0fad688a44ff78b245b8439db2 (patch)
tree67b40d4347d3f394681aaa1c671758d5b7708774
parenta4ec297925f052bf9ea1aba9f584eaaf7472fb93 (diff)
downloadangular.js-61fb5863df4afe0fad688a44ff78b245b8439db2.tar.bz2
feat(ngDocs): add links to source for API
- add tests - the link points to the gruntUtil.getVersion().number tree on github
-rw-r--r--docs/spec/sourceLinkSpec.js29
-rw-r--r--docs/src/ngdoc.js13
-rw-r--r--docs/src/templates/css/docs.css3
3 files changed, 42 insertions, 3 deletions
diff --git a/docs/spec/sourceLinkSpec.js b/docs/spec/sourceLinkSpec.js
new file mode 100644
index 00000000..3dc73cc8
--- /dev/null
+++ b/docs/spec/sourceLinkSpec.js
@@ -0,0 +1,29 @@
+var ngdoc = require('../src/ngdoc.js');
+var gruntUtil = require('../../lib/grunt/utils.js');
+
+describe('Docs Links', function() {
+
+ describe('links', function() {
+ var doc;
+
+ beforeEach(function() {
+ doc = new ngdoc.Doc("@ngdoc function\n@name ng.filter:a\n@function");
+ doc.section = 'api';
+ doc.file = 'test.js';
+ doc.line = 42;
+ doc.parse();
+ });
+
+ it('should have an "improve this doc" button', function() {
+ expect(doc.html()).
+ toContain('<a href="http://github.com/angular/angular.js/edit/master/test.js" class="improve-docs btn btn-primary"><i class="icon-edit"> </i> Improve this doc</a>');
+ });
+
+ it('should have an "view source" button', function() {
+ expect(doc.html()).
+ toContain('<a href="http://github.com/angular/angular.js/tree/v' + gruntUtil.getVersion().number + '/test.js#L42" class="view-source btn btn-action"><i class="icon-zoom-in"> </i> View source</a>');
+ });
+
+ });
+
+});
diff --git a/docs/src/ngdoc.js b/docs/src/ngdoc.js
index 84a165f2..d1ebb388 100644
--- a/docs/src/ngdoc.js
+++ b/docs/src/ngdoc.js
@@ -274,7 +274,16 @@ Doc.prototype = {
dom.h(title(this.name), function() {
notice('deprecated', 'Deprecated API', self.deprecated);
- dom.tag('a', {href: 'http://github.com/angular/angular.js/edit/master/' + self.file, class: 'improve-docs btn btn-primary'}, 'Improve this doc');
+ dom.tag('a', {href: 'http://github.com/angular/angular.js/edit/master/' + self.file, class: 'improve-docs btn btn-primary'}, function(dom) {
+ dom.tag('i', {class:'icon-edit'}, ' ');
+ dom.text(' Improve this doc');
+ });
+ if (self.section === 'api') {
+ dom.tag('a', {href: 'http://github.com/angular/angular.js/tree/v' + gruntUtil.getVersion().number + '/' + self.file + '#L' + self.line, class: 'view-source btn btn-action'}, function(dom) {
+ dom.tag('i', {class:'icon-zoom-in'}, ' ');
+ dom.text(' View source');
+ });
+ }
if (self.ngdoc != 'overview') {
dom.h('Description', self.description, dom.html);
}
@@ -297,7 +306,7 @@ Doc.prototype = {
//////////////////////////
function notice(name, legend, msg){
- if (self[name] == undefined) return;
+ if (self[name] === undefined) return;
dom.tag('fieldset', {'class':name}, function(dom){
dom.tag('legend', legend);
dom.text(msg);
diff --git a/docs/src/templates/css/docs.css b/docs/src/templates/css/docs.css
index 0bb631d8..27d2bcd3 100644
--- a/docs/src/templates/css/docs.css
+++ b/docs/src/templates/css/docs.css
@@ -86,8 +86,9 @@ img.AngularJS-small {
/* Content */
/* =============================== */
-.improve-docs {
+.improve-docs, .view-source {
float: right;
+ margin: 0 5px;
}
.hint {