diff --git a/docs/dgeni-conf.js b/docs/dgeni-conf.js index 4d24a09..d6a7d1c 100644 --- a/docs/dgeni-conf.js +++ b/docs/dgeni-conf.js @@ -4,7 +4,7 @@ var Package = require('dgeni').Package; module.exports = new Package('dgeni-example', [ - require('dgeni-packages/angularjs'), + require('dgeni-packages/ngdoc'), require('dgeni-packages/jsdoc'), require('dgeni-packages/nunjucks') ]) @@ -32,16 +32,16 @@ module.exports = new Package('dgeni-example', [ variableEnd: '$}' }; - templateFinder.templateFolders - .unshift(path.resolve(__dirname, 'templates')); + // templateFinder.templateFolders + // .unshift(path.resolve(__dirname, 'templates')); - templateFinder.templatePatterns = [ - '${ doc.template }', - '${ doc.id }.${ doc.docType }.template.html', - '${ doc.id }.template.html', - '${ doc.docType }.template.html', - 'common.template.html' - ]; + // templateFinder.templatePatterns = [ + // '${ doc.template }', + // '${ doc.id }.${ doc.docType }.template.html', + // '${ doc.id }.template.html', + // '${ doc.docType }.template.html', + // 'common.template.html' + // ]; }) diff --git a/docs/templates/base.template.html b/docs/templates/base.template.html deleted file mode 100644 index 04c9ed0..0000000 --- a/docs/templates/base.template.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - Dgeni Angular - - - - - - - - - - - {% block body %}{% endblock %} - - - diff --git a/docs/templates/common.template.html b/docs/templates/common.template.html deleted file mode 100644 index 50044e2..0000000 --- a/docs/templates/common.template.html +++ /dev/null @@ -1,10 +0,0 @@ -{% extends 'base.template.html' %} - -{% block body %} -

{$ doc.name $}

-({$ doc.docType $}) - -

{$ doc.description $}

- -{$ doc.parent | relativeLink(doc, 'Go Up') $} -{% endblock %} \ No newline at end of file diff --git a/docs/templates/componentGroup.template.html b/docs/templates/componentGroup.template.html deleted file mode 100644 index 59360ae..0000000 --- a/docs/templates/componentGroup.template.html +++ /dev/null @@ -1,13 +0,0 @@ -{% extends 'base.template.html' %} - -{% block body %} -

{$ doc.title $} in {$ doc.module.name $}

- - -{% endblock %} \ No newline at end of file diff --git a/docs/templates/ngController.template.html b/docs/templates/ngController.template.html deleted file mode 100644 index e1e5707..0000000 --- a/docs/templates/ngController.template.html +++ /dev/null @@ -1,12 +0,0 @@ -{% extends 'base.template.html' %} - -{% block body %} -

{$ doc.name $}

-

controller in {$ doc.module | relativeLink(doc) $}

- -
- {$ doc.description | marked $} -
- -{% include "partials/dependencies.template.html" %} -{% endblock %} \ No newline at end of file diff --git a/docs/templates/ngDirective.template.html b/docs/templates/ngDirective.template.html deleted file mode 100644 index 79eac13..0000000 --- a/docs/templates/ngDirective.template.html +++ /dev/null @@ -1,12 +0,0 @@ -{% extends 'base.template.html' %} - -{% block body %} -

{$ doc.name $}

-

directive in {$ doc.module | relativeLink(doc) $}

- -
- {$ doc.description | marked $} -
- -{% include "partials/dependencies.template.html" %} -{% endblock %} \ No newline at end of file diff --git a/docs/templates/ngFilter.template.html b/docs/templates/ngFilter.template.html deleted file mode 100644 index 0323118..0000000 --- a/docs/templates/ngFilter.template.html +++ /dev/null @@ -1,12 +0,0 @@ -{% extends 'base.template.html' %} - -{% block body %} -

{$ doc.name $}

-

filter in {$ doc.module | relativeLink(doc) $}

- -
- {$ doc.description | marked $} -
- -{% include "partials/dependencies.template.html" %} -{% endblock %} \ No newline at end of file diff --git a/docs/templates/ngModule.template.html b/docs/templates/ngModule.template.html deleted file mode 100644 index 0fadea1..0000000 --- a/docs/templates/ngModule.template.html +++ /dev/null @@ -1,26 +0,0 @@ -{% extends 'base.template.html' %} - -{% block body %} -
-

{$ doc.name $} Module

- -
- {$ doc.description | marked $} -
- {% include "partials/dependencies.template.html" %} -
- -{% for groupName, group in doc.groups %} -{% if group.children.length %} - -

{$ group | relativeLink(doc, group.title) $}

- -{%- endif %} -{%- endfor %} -{% endblock %} \ No newline at end of file diff --git a/docs/templates/ngService.template.html b/docs/templates/ngService.template.html deleted file mode 100644 index c5d636e..0000000 --- a/docs/templates/ngService.template.html +++ /dev/null @@ -1,12 +0,0 @@ -{% extends 'base.template.html' %} - -{% block body %} -

{$ doc.name $}

-

service in {$ doc.module | relativeLink(doc) $}

- -
- {$ doc.description | marked $} -
- -{% include "partials/dependencies.template.html" %} -{% endblock %} \ No newline at end of file diff --git a/docs/templates/partials/dependencies.template.html b/docs/templates/partials/dependencies.template.html deleted file mode 100644 index 27f0ccf..0000000 --- a/docs/templates/partials/dependencies.template.html +++ /dev/null @@ -1,12 +0,0 @@ -{% if doc.dependencies.length -%} - -

Dependencies

- - -{%- endif %} \ No newline at end of file diff --git a/package.json b/package.json index bd2e272..f4f1171 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "canonical-path": "0.0.2", "del": "^0.1.3", "dgeni": "^0.4.0", - "dgeni-packages": "git://github.com/angular/dgeni-packages.git#angular-docs", + "dgeni-packages": "^0.10.12", "gulp": "^3.5.6", "run-sequence": "^1.0.1" }, diff --git a/src/app.js b/src/app.js index e9a24b3..85dbc0c 100644 --- a/src/app.js +++ b/src/app.js @@ -1,5 +1,10 @@ /** + * @ngdoc module + * @name app + * @module app + * @description + * * The main application module. - * It depends upon {@link mod1} and {@link mod2}. + * It depends upon {@link module:mod1} and {@link module:mod2}. */ -angular.module('app', ['mod1', 'mod2']); \ No newline at end of file +angular.module('app', ['mod1', 'mod2']); diff --git a/src/mod1.js b/src/mod1.js index 9c1883d..4992278 100644 --- a/src/mod1.js +++ b/src/mod1.js @@ -1,4 +1,19 @@ /** + * @ngdoc module + * @name mod1 + * @module mod1 + * + * @description + * + * Contains helper services + */ + +/** + * @ngdoc service + * @name service1 + * @module mod1 + * @description + * * Contains helper services */ angular.module('mod1', []) @@ -16,4 +31,4 @@ angular.module('mod1', []) }); } }; -}]); \ No newline at end of file +}]); diff --git a/src/mod2.js b/src/mod2.js index 65ecd77..a4427b2 100644 --- a/src/mod2.js +++ b/src/mod2.js @@ -1,9 +1,19 @@ /** + * @ngdoc module + * @name mod2 + * @description + * * Controllers and directives + * */ angular.module('mod2', ['mod1']) /** + * @ngdoc type + * @name MyCtrl + * @module mod2 + * @description + * * Attaches the `getItem` helper to the scope */ .controller('MyCtrl', ['$scope', 'service1', function($scope, service1) { @@ -15,6 +25,11 @@ angular.module('mod2', ['mod1']) }]) /** + * @ngdoc directive + * @name directive1 + * @module mod2 + * @description + * * Does something special with the DOM */ .directive('directive1', function() { @@ -28,4 +43,4 @@ angular.module('mod2', ['mod1']) var div = angular.element('
'); } }; -}); \ No newline at end of file +});