Skip to content

Commit 1da5588

Browse files
committed
refactor: Remove unused code from jsdoc publish.js
1 parent fd964d4 commit 1da5588

File tree

1 file changed

+0
-147
lines changed

1 file changed

+0
-147
lines changed

internal/documentation/jsdoc/docdash/publish.js

Lines changed: 0 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -236,20 +236,9 @@ function generate(type, title, docs, filename, resolveLinks) {
236236
function generateSourceFiles(sourceFiles, encoding) {
237237
encoding = encoding || 'utf8';
238238
Object.keys(sourceFiles).forEach(function(file) {
239-
var source;
240239
// links are keyed to the shortened path in each doclet's `meta.shortpath` property
241240
var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened);
242241
helper.registerLink(sourceFiles[file].shortened, sourceOutfile);
243-
244-
try {
245-
source = {
246-
kind: 'source',
247-
code: helper.htmlsafe( fs.readFileSync(sourceFiles[file].resolved, encoding) )
248-
};
249-
}
250-
catch(e) {
251-
logger.error('Error while generating source file %s: %s', file, e.message);
252-
}
253242
});
254243
}
255244

@@ -294,108 +283,6 @@ function attachModuleSymbols(doclets, modules) {
294283
});
295284
}
296285

297-
// Removed navbar functionality
298-
/*
299-
function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
300-
var nav = '';
301-
302-
if (items && items.length) {
303-
var itemsNav = '';
304-
305-
items.forEach(function(item) {
306-
var methods = find({kind:'function', memberof: item.longname});
307-
var members = find({kind:'member', memberof: item.longname});
308-
var docdash = env && env.conf && env.conf.docdash || {};
309-
310-
if ( !hasOwnProp.call(item, 'longname') ) {
311-
itemsNav += '<li>' + linktoFn('', item.name);
312-
itemsNav += '</li>';
313-
} else if ( !hasOwnProp.call(itemsSeen, item.longname) ) {
314-
itemsNav += '<li>' + linktoFn(item.longname, item.name.replace(/^module:/, ''));
315-
316-
if (docdash.static && members.find(function (m) { return m.scope === 'static'; } )) {
317-
itemsNav += "<ul class='members'>";
318-
319-
members.forEach(function (member) {
320-
if (!member.scope === 'static') return;
321-
itemsNav += "<li data-type='member'>";
322-
itemsNav += linkto(member.longname, member.name);
323-
itemsNav += "</li>";
324-
});
325-
326-
itemsNav += "</ul>";
327-
}
328-
329-
if (methods.length) {
330-
itemsNav += "<ul class='methods'>";
331-
332-
methods.forEach(function (method) {
333-
itemsNav += "<li data-type='method'>";
334-
itemsNav += linkto(method.longname, method.name);
335-
itemsNav += "</li>";
336-
});
337-
338-
itemsNav += "</ul>";
339-
}
340-
341-
itemsNav += '</li>';
342-
itemsSeen[item.longname] = true;
343-
}
344-
});
345-
346-
if (itemsNav !== '') {
347-
nav += '<h3>' + itemHeading + '</h3><ul>' + itemsNav + '</ul>';
348-
}
349-
}
350-
351-
return nav;
352-
}
353-
354-
function linktoTutorial(longName, name) {
355-
return tutoriallink(name);
356-
}
357-
358-
function linktoExternal(longName, name) {
359-
return linkto(longName, name.replace(/(^"|"$)/g, ''));
360-
}
361-
362-
function buildNav(members) {
363-
var nav = '<h2><a href="index.html">Home</a></h2>';
364-
var seen = {};
365-
var seenTutorials = {};
366-
367-
nav += buildMemberNav(members.tutorials, 'Tutorials', seenTutorials, linktoTutorial);
368-
nav += buildMemberNav(members.classes, 'Classes', seen, linkto);
369-
nav += buildMemberNav(members.modules, 'Modules', {}, linkto);
370-
nav += buildMemberNav(members.externals, 'Externals', seen, linktoExternal);
371-
nav += buildMemberNav(members.events, 'Events', seen, linkto);
372-
nav += buildMemberNav(members.namespaces, 'Namespaces', seen, linkto);
373-
nav += buildMemberNav(members.mixins, 'Mixins', seen, linkto);
374-
nav += buildMemberNav(members.interfaces, 'Interfaces', seen, linkto);
375-
376-
if (members.globals.length) {
377-
var globalNav = '';
378-
379-
members.globals.forEach(function(g) {
380-
if ( g.kind !== 'typedef' && !hasOwnProp.call(seen, g.longname) ) {
381-
globalNav += '<li>' + linkto(g.longname, g.name) + '</li>';
382-
}
383-
seen[g.longname] = true;
384-
});
385-
386-
if (!globalNav) {
387-
// turn the heading into a link so you can actually get to the global page
388-
nav += '<h3>' + linkto('global', 'Global') + '</h3>';
389-
}
390-
else {
391-
nav += '<h3>Global</h3><ul>' + globalNav + '</ul>';
392-
}
393-
}
394-
395-
return nav;
396-
}
397-
*/
398-
399286
/**
400287
@param {TAFFY} taffyData See <http://taffydb.com/>.
401288
@param {object} opts
@@ -488,40 +375,6 @@ exports.publish = function(taffyData, opts, tutorials) {
488375
fs.mkPath(outdir);
489376

490377
// Modified: Static files are not needed anymore
491-
// copy the template's static files to outdir
492-
/*var fromDir = path.join(templatePath, 'static');
493-
var staticFiles = fs.ls(fromDir, 3);
494-
495-
staticFiles.forEach(function(fileName) {
496-
var toDir = fs.toDir( fileName.replace(fromDir, outdir) );
497-
fs.mkPath(toDir);
498-
fs.copyFileSync(fileName, toDir);
499-
});
500-
501-
// copy user-specified static files to outdir
502-
var staticFilePaths;
503-
var staticFileFilter;
504-
var staticFileScanner;
505-
if (conf.default.staticFiles) {
506-
// The canonical property name is `include`. We accept `paths` for backwards compatibility
507-
// with a bug in JSDoc 3.2.x.
508-
staticFilePaths = conf.default.staticFiles.include ||
509-
conf.default.staticFiles.paths ||
510-
[];
511-
staticFileFilter = new (require('jsdoc/src/filter')).Filter(conf.default.staticFiles);
512-
staticFileScanner = new (require('jsdoc/src/scanner')).Scanner();
513-
514-
staticFilePaths.forEach(function(filePath) {
515-
var extraStaticFiles = staticFileScanner.scan([filePath], 10, staticFileFilter);
516-
517-
extraStaticFiles.forEach(function(fileName) {
518-
var sourcePath = fs.toDir(filePath);
519-
var toDir = fs.toDir( fileName.replace(sourcePath, outdir) );
520-
fs.mkPath(toDir);
521-
fs.copyFileSync(fileName, toDir);
522-
});
523-
});
524-
}*/
525378

526379
if (sourceFilePaths.length) {
527380
sourceFiles = shortenPaths( sourceFiles, path.commonPrefix(sourceFilePaths) );

0 commit comments

Comments
 (0)