Skip to content

Commit 6a45863

Browse files
artchartch
committed
Merge pull request #113 from wingedfox/docs-merge
Added thorough docs
2 parents e1aed89 + 3f46ba4 commit 6a45863

14 files changed

+634
-271
lines changed

‎Gruntfile.js

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,14 @@ module.exports = function(grunt) {
5050
autoWatch: false,
5151
singleRun: true
5252
}
53+
},
54+
angular15: {
55+
options: {
56+
keepalive: true,
57+
configFile: 'karma-angular-1.5.conf.js',
58+
autoWatch: false,
59+
singleRun: true
60+
}
5361
}
5462
},
5563

@@ -59,15 +67,35 @@ module.exports = function(grunt) {
5967
prop: 'gitdescribe'
6068
}
6169
}
70+
},
71+
72+
"dgeni-alive": {
73+
options: {
74+
serve: {
75+
port: '10000',
76+
openBrowser: false
77+
},
78+
},
79+
api: {
80+
title: '<%= pkg.title %>',
81+
version: '<%= pkg.version %>',
82+
expand: false,
83+
src: [
84+
'src/**/*.js',
85+
'docs/**/*.ngdoc'
86+
],
87+
dest: 'build/docs'
88+
}
6289
}
63-
90+
6491
});
6592

6693
grunt.loadNpmTasks('grunt-contrib-concat');
6794
grunt.loadNpmTasks('grunt-contrib-uglify');
6895
grunt.loadNpmTasks('grunt-karma');
6996
grunt.loadNpmTasks('grunt-git-describe');
70-
97+
grunt.loadNpmTasks('dgeni-alive');
98+
7199
grunt.registerTask('default', ['concat:prod']);
72100
grunt.registerTask('prod', ['git-describe:run', 'concat:prod', 'uglify']);
73101
};

‎bower.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"karma-angular-1.2.conf.js",
1414
"karma-angular-1.3.conf.js",
1515
"karma-angular-1.4.conf.js",
16+
"karma-angular-1.5.conf.js",
1617
"package.json",
1718
"src",
1819
"**/*.min.js"

‎docs/api/index.ngdoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
@ngdoc overview
2+
@name API Reference
3+
@area api
4+
@id api-index
5+
@description
6+
# Angular-route-segment API Docs
7+
8+
Welcome to the angular-route-segment API docs page. These pages contain the reference materials for version <strong ng-bind="version"></strong>.
9+
10+
## Modules
11+
12+
## {@link route-segment route-segment (routing module)}
13+
Module defines routing configuration.
14+
15+
## {@link view-segment view-segment (presentation module)}
16+
Module defines routing views and helper components.

‎karma-angular-1.2.conf.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ module.exports = function(config) {
33

44
basePath: './',
55

6-
frameworks: ["jasmine"],
6+
frameworks: [
7+
'jasmine',
8+
'jasmine-jquery-matchers'
9+
],
710

811
files: [
9-
'test/lib/jquery.min.js',
10-
'test/lib/helpers.js',
1112
'https://ajax.googleapis.com/ajax/libs/angularjs/1.2.21/angular.js',
1213
'https://ajax.googleapis.com/ajax/libs/angularjs/1.2.21/angular-route.js',
1314
'https://ajax.googleapis.com/ajax/libs/angularjs/1.2.21/angular-animate.js',

‎karma-angular-1.3.conf.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ module.exports = function(config) {
33

44
basePath: './',
55

6-
frameworks: ["jasmine"],
6+
frameworks: [
7+
'jasmine',
8+
'jasmine-jquery-matchers'
9+
],
710

811
files: [
9-
'test/lib/jquery.min.js',
10-
'test/lib/helpers.js',
1112
'https://ajax.googleapis.com/ajax/libs/angularjs/1.3.16/angular.js',
1213
'https://ajax.googleapis.com/ajax/libs/angularjs/1.3.16/angular-route.js',
1314
'https://ajax.googleapis.com/ajax/libs/angularjs/1.3.16/angular-animate.js',

‎karma-angular-1.4.conf.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ module.exports = function(config) {
33

44
basePath: './',
55

6-
frameworks: ["jasmine"],
6+
frameworks: [
7+
'jasmine',
8+
'jasmine-jquery-matchers'
9+
],
710

811
files: [
9-
'test/lib/jquery.min.js',
10-
'test/lib/helpers.js',
1112
'https://ajax.googleapis.com/ajax/libs/angularjs/1.4.0/angular.js',
1213
'https://ajax.googleapis.com/ajax/libs/angularjs/1.4.0/angular-route.js',
1314
'https://ajax.googleapis.com/ajax/libs/angularjs/1.4.0/angular-animate.js',

‎karma-angular-1.5.conf.js

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
module.exports = function(config) {
2+
config.set({
3+
4+
basePath: './',
5+
6+
frameworks: [
7+
'jasmine',
8+
'jasmine-jquery-matchers'
9+
],
10+
11+
files: [
12+
'https://ajax.googleapis.com/ajax/libs/angularjs/1.5.0-rc.1/angular.js',
13+
'https://ajax.googleapis.com/ajax/libs/angularjs/1.5.0-rc.1/angular-route.js',
14+
'https://ajax.googleapis.com/ajax/libs/angularjs/1.5.0-rc.1/angular-animate.js',
15+
'https://ajax.googleapis.com/ajax/libs/angularjs/1.5.0-rc.1/angular-mocks.js',
16+
'https://ajax.googleapis.com/ajax/libs/angularjs/1.5.0-rc.1/angular-scenario.js',
17+
'src/**/*.js',
18+
'test/unit/**/*.js'
19+
],
20+
21+
autoWatch: true,
22+
23+
browsers: ['PhantomJS']
24+
25+
});
26+
};

‎package.json

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,26 @@
11
{
2-
"name": "angular-route-segment",
3-
"version": "1.5.0",
4-
"devDependencies": {
5-
"grunt": "",
6-
"grunt-contrib-uglify": "",
7-
"grunt-contrib-concat": "",
8-
"grunt-karma": "",
9-
"karma": "",
10-
"karma-jasmine": "0.1.5",
11-
"karma-phantomjs-launcher": "",
12-
"karma-junit-reporter": "",
13-
"grunt-git-describe": ""
14-
},
15-
"main": "build/angular-route-segment.js",
16-
"scripts": {
17-
"test": "grunt karma"
18-
}
2+
"name": "angular-route-segment",
3+
"title": "Angular Route Segment",
4+
"version": "1.5.0",
5+
"devDependencies": {
6+
"dgeni-alive": "~0.0.5",
7+
"grunt": "",
8+
"grunt-contrib-concat": "",
9+
"grunt-contrib-uglify": "",
10+
"grunt-git-describe": "",
11+
"grunt-karma": "",
12+
"jasmine-core": "~2.4.1",
13+
"jasmine-jquery-matchers": "~1.0.1",
14+
"jquery": "~2.2.0",
15+
"karma": "~0.13.19",
16+
"karma-jasmine": "~0.3.6",
17+
"karma-jasmine-jquery-matchers": "~1.0.0",
18+
"karma-junit-reporter": "",
19+
"karma-phantomjs-launcher": "~1.0.0",
20+
"phantomjs-prebuilt": "~2.1.3"
21+
},
22+
"main": "build/angular-route-segment.js",
23+
"scripts": {
24+
"test": "grunt karma"
25+
}
1926
}

0 commit comments

Comments
 (0)