archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

show tutorials in the TOC nav (#875)

Browse Source
This commit is contained in:
Jeff Williams 2015-01-11 18:30:08 -08:00
parent b7812b5de4
commit dad0544e93
3 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/jsdoc/tutorial.js
View File

@ -43,7 +43,7 @@ function addChild(parent, child) {
@param {number} type - Source formating. @param {number} type - Source formating.
*/ */
exports.Tutorial = function(name, content, type) { exports.Tutorial = function(name, content, type) {
this.title = this.name = name; this.title = this.name = this.longname = name;
this.content = content; this.content = content;
this.type = type; this.type = type;

7
templates/default/publish.js
View File

@ -335,8 +335,9 @@ function linktoExternal(longName, name) {
* @return {string} The HTML for the navigation sidebar. * @return {string} The HTML for the navigation sidebar.
*/ */
function buildNav(members) { function buildNav(members) {
var nav = '<h2><a href="index.html">Home</a></h2>', var nav = '<h2><a href="index.html">Home</a></h2>';
seen = {}; var seen = {};
var seenTutorials = {};
nav += buildMemberNav(members.modules, 'Modules', {}, linkto); nav += buildMemberNav(members.modules, 'Modules', {}, linkto);
nav += buildMemberNav(members.externals, 'Externals', seen, linktoExternal); nav += buildMemberNav(members.externals, 'Externals', seen, linktoExternal);
@ -344,7 +345,7 @@ function buildNav(members) {
nav += buildMemberNav(members.events, 'Events', seen, linkto); nav += buildMemberNav(members.events, 'Events', seen, linkto);
nav += buildMemberNav(members.namespaces, 'Namespaces', seen, linkto); nav += buildMemberNav(members.namespaces, 'Namespaces', seen, linkto);
nav += buildMemberNav(members.mixins, 'Mixins', seen, linkto); nav += buildMemberNav(members.mixins, 'Mixins', seen, linkto);
nav += buildMemberNav(members.tutorials, 'Tutorials', seen, linktoTutorial); nav += buildMemberNav(members.tutorials, 'Tutorials', seenTutorials, linktoTutorial);
nav += buildMemberNav(members.interfaces, 'Interfaces', seen, linkto); nav += buildMemberNav(members.interfaces, 'Interfaces', seen, linkto);
if (members.globals.length) { if (members.globals.length) {

5
test/specs/jsdoc/tutorial.js
View File

@ -72,6 +72,11 @@ describe('jsdoc/tutorial', function() {
expect(tute.name).toBe(name); expect(tute.name).toBe(name);
}); });
it('should have a "longname" property', function() {
expect(typeof tute.longname).toBe('string');
expect(tute.longname).toBe(name);
});
it("should have a 'title' property, by default set to to the tutorial's name", function() { it("should have a 'title' property, by default set to to the tutorial's name", function() {
expect(tute.title).toBeDefined(); expect(tute.title).toBeDefined();
expect(typeof tute.title).toBe('string'); expect(typeof tute.title).toBe('string');