From d083a879ce3d2b12a809a2a07f6e58f70afd672b Mon Sep 17 00:00:00 2001 From: Michael Mathews Date: Tue, 30 Aug 2011 22:42:04 +0100 Subject: [PATCH] Symbols marked with @ignore are now filtered out of the published documentation. --- package.json | 2 +- templates/default/publish.js | 33 +++++++++++++++++---------------- 2 files changed, 18 insertions(+), 17 deletions(-) diff --git a/package.json b/package.json index 32069352..c3ef53eb 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "JSDoc", "version": "3.0.0alpha", - "revision": "1314689969938", + "revision": "1314740275645", "description": "An automatic documentation generator for javascript.", "keywords": [ "documentation", "javascript" ], "licenses": [ diff --git a/templates/default/publish.js b/templates/default/publish.js index 510dea57..951e6237 100644 --- a/templates/default/publish.js +++ b/templates/default/publish.js @@ -56,7 +56,7 @@ var ancestors = []; while (doc = doc.memberof) { - doc = data.get( data.find({longname: doc}) ); + doc = find({longname: doc}); if (doc) { doc = doc[0]; } if (!doc) break; ancestors.unshift( linkto(doc.longname, doc.name) ); @@ -107,8 +107,9 @@ } data.remove({undocumented: true}); + data.remove({ignore: true}); - var packageInfo = (data.get( data.find({kind: 'package'}) ) || []) [0]; + var packageInfo = (find({kind: 'package'}) || []) [0]; //function renderLinks(text) { // return helper.resolveLinks(text); @@ -154,10 +155,10 @@ data.orderBy(['longname', 'version', 'since']); // kinds of containers - var globals = data.get( data.find({kind: ['property', 'function'], memberof: {isUndefined: true}}) ), - modules = data.get( data.find({kind: 'module'}) ), - mixins = data.get( data.find({kind: 'mixin'}) ), - namespaces = data.get( data.find({kind: 'namespace'}) ); + var globals = find( {kind: ['property', 'function'], memberof: {isUndefined: true}} ), + modules = find({kind: 'module'}), + mixins = find({kind: 'mixin'}), + namespaces = find({kind: 'namespace'}); var outdir = opts.destination; if (packageInfo) { @@ -198,7 +199,7 @@ var nav = '', seen = {}; - var moduleNames = data.get( data.find({kind: 'module'}) ); + var moduleNames = find({kind: 'module'}); if (moduleNames.length) { nav = nav + '

Modules

'; } - var classNames = data.get( data.find({kind: 'class'}) ); + var classNames = find({kind: 'class'}); if (classNames.length) { nav = nav + '

Classes

'; } - var namespaceNames = data.get( data.find({kind: 'namespace'}) ); + var namespaceNames = find({kind: 'namespace'}); if (namespaceNames.length) { nav = nav + '

Namespaces

'; } - var mixinNames = data.get( data.find({kind: 'mixin'}) ); + var mixinNames = find({kind: 'mixin'}); if (mixinNames.length) { nav = nav + '

Mixins

'; } - var globalNames = data.get( data.find({kind: ['property', 'function'], 'memberof': {'isUndefined': true}}) ); + var globalNames = find({kind: ['property', 'function'], 'memberof': {'isUndefined': true}}); if (globalNames.length) { nav = nav + '

Global