Игнорирование тегов в yuidoc javascript documentor

Question

Можно ли игнорировать различные теги в yuidoc, чтобы сделать сообщения о сборке документации более полезными.

У меня есть проблемы с тегами, как @author, @date и т.д.

/** 
* The XYZ View ... 
* These tags yuidoc result in a yuidoc warning 
* 
* @company <company name> 
* @date Mon Aug 27 2013 22:30:50 GMT+0200 (CEST) 
* 
* These tags yuidoc is able to interpret 
* @author Bernhard <email@foo> 
* @module Welcome  
* @submodule Frontend 
* @class WelcomeView 
* @constructor 
* 
*/ 

// Yuidoc throws warnings like 
warn: (docparser): unknown tag: company, path/to/file.js:1 
warn: (docparser): unknown tag: date, path/to/file.js:1:1 

И есть тонны файлов, что делает его невозможно найти «реальное» предупреждение» Есть ли способ Exlude теги в yuidoc?

Answer 1

на основании исследования я проводил, YUIDoc не предоставляет никаких средств, чтобы установить список тегов игнорировать, ни каких-либо других средств, чтобы отсеивать эти предупреждения.

Однако то, что вы можете сделать это, как следует:

1. (необязательно) Вилка существующая YUIDoc project

2. Edit yuidocjs/lib/docparser.js и добавьте нужные теги в TAGLIST:

   TAGLIST = [ 
       // ... 
       "conditional", // conditional module 
       "company", 
       "config", // a config param (not an attribute, so no change events) 
       // ... 
       "contributor", // like author 
       "date", 
       "default", // property/attribute default value 
       // ... 
   ] 
   

3. Run YUIDoc в обычном режиме и смотреть, как предупреждения исчезают!

Обратите внимание, что эти поля не будут отображаться в документации, но, похоже, ваша основная проблема заключается в том, как опустить предупреждения. Если вы хотите обрабатывать теги, вам нужно внести изменения в список DIGESTERS.