From 3c80cf3df607464ea95acc6595c521d8fd32de2c Mon Sep 17 00:00:00 2001 From: Misko Hevery Date: Wed, 31 Aug 2011 12:21:27 -0700 Subject: style(docs): improve the formatting of events in docs --- docs/src/ngdoc.js | 13 ++++++++----- docs/src/templates/docs.css | 5 +++++ src/service/route.js | 6 +++--- 3 files changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/src/ngdoc.js b/docs/src/ngdoc.js index a9abe7a6..e47848d0 100644 --- a/docs/src/ngdoc.js +++ b/docs/src/ngdoc.js @@ -221,7 +221,7 @@ Doc.prototype = { } else if(atName == 'eventType') { var match = text.match(/^([^\s]*)\s+on\s+([\S\s]*)/); self.type = match[1]; - self.source = match[2]; + self.target = match[2]; } else { self[atName] = text; } @@ -531,11 +531,14 @@ Doc.prototype = { }); }); dom.h('Events', this.events, function(event){ - var signature = (event.param || []).map(property('name')); - dom.h(event.type + ' ' + - event.shortName + '(' + signature.join(', ') + ') on ' + - event.source, event, function(){ + dom.h(event.shortName, event, function(){ dom.html(event.description); + dom.tag('div', {class:'inline'}, function(){ + dom.h('Type:', event.type); + }); + dom.tag('div', {class:'inline'}, function(){ + dom.h('Target:', event.target); + }); event.html_usage_parameters(dom); self.html_usage_this(dom); diff --git a/docs/src/templates/docs.css b/docs/src/templates/docs.css index 6ba83568..f3418649 100644 --- a/docs/src/templates/docs.css +++ b/docs/src/templates/docs.css @@ -420,3 +420,8 @@ li { [ng\:cloak], .ng-cloak { display: none; } + +.inline * { + display: inline; +} + diff --git a/src/service/route.js b/src/service/route.js index 523a244a..6d04e89a 100644 --- a/src/service/route.js +++ b/src/service/route.js @@ -70,7 +70,7 @@ angularServiceInject('$route', function($location, $routeParams) { * @ngdoc event * @name angular.service.$route#$beforeRouteChange * @eventOf angular.service.$route - * @eventType Broadcast on root scope + * @eventType broadcast on root scope * @description * Broadcasted before a route change. * @@ -89,7 +89,7 @@ angularServiceInject('$route', function($location, $routeParams) { * @ngdoc event * @name angular.service.$route#$afterRouteChange * @eventOf angular.service.$route - * @eventType Broadcast on root scope + * @eventType broadcast on root scope * @description * Broadcasted after a route change. * @@ -108,7 +108,7 @@ angularServiceInject('$route', function($location, $routeParams) { * @ngdoc event * @name angular.service.$route#$routeUpdate * @eventOf angular.service.$route - * @eventType Emit on the current route scope. + * @eventType emit on the current route scope * @description * * The `reloadOnSearch` property has been set to false, and we are reusing the same -- cgit v1.2.3