chore(doc-gen): add inline @type tag

mkuehn · Mar 7, 2014 · 0b4a41a · 0b4a41a
1 parent 0e06669
commit 0b4a41a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/config/index.js b/docs/config/index.js
@@ -25,6 25,10 @@ module.exports = function(config) {
  require('./tag-defs/tutorial-step')
  ]);
 
  config.append('processing.inlineTagDefinitions', [
  require('./inline-tag-defs/type')
  ]);
 
  config.set('processing.search.ignoreWordsFile', path.resolve(packagePath, 'ignore.words'));
 
  config.prepend('rendering.templateFolders', [

diff --git a/docs/config/inline-tag-defs/type.js b/docs/config/inline-tag-defs/type.js
@@ -0,0 1,12 @@
 var typeClassFilter = require('dgeni-packages/ngdoc/rendering/filters/type-class');
 var encoder = new require('node-html-encoder').Encoder();
 
 module.exports = {
  name: 'type',
  description: 'Replace with markup that displays a nice type',
  handlerFactory: function() {
  return function(doc, tagName, tagDescription) {
  return '<a href="" class="'   typeClassFilter.process(tagDescription)   '">' encoder.htmlEncode(tagDescription)   '</a>';
  };
  }
 };