«Домашний» текст и контент по умолчанию для JSDoc
После запуска базовой JSDoc-компиляции / рендеринга из Node.js:
jsdoc file1.js file2.js
Я получаю хорошо отформатированный документ, используя шаблон по умолчанию внутри директории "out". Почти все как и ожидалось!
Но при открытии документа на странице index.html всегда отображается «Домашняя страница», на этой начальной странице нет содержимого, а на боковой панели есть «Домашняя страница».
Как и где мне записать название проекта, чтобы он заменял «Дом»? Я также хотел бы видеть описание проекта, а также информацию об авторе и авторских правах.
Кажется, что самое основное, что можно сделать в JSDoc, но я не могу найти информацию! Я попробовал следующее, основываясь на какой-то случайной статье, которую я нашел в Интернете:
/**
* This JavaScript file contains foo bar baz...
*
* @projectname Project Name
* @version 0.1
* @author Greg Pettit
* @copyright 2015
*
*/
Но я не получаю любви.
[отредактировано, чтобы добавить:]
Обнаружена директива @file / @fileOverview / @overview (все синонимы), которая несколько полезна, поскольку теперь я могу описать и установить информацию об авторских правах / авторах для каждого файла:
/**
* @file Project description which renders below the individual filename and therefore isn't a real overview blurb.
*
* @version 0.1
* @author Greg Pettit
* @copyright 2015
*
*/
Это оставляет 2 «проблемы» для решения еще:
Обзорное описание; Я думаю, что @file позаботится о большинстве моих потребностей, но, так как это для каждого файла, я все же хотел бы абзац типа «введение» или обзорный абзац, который появляется перед описаниями включаемых файлов.
Замена этого текста "Home" пользовательским текстом