Создание ошибок qooxdoo api и ignore

Question

возможно ли генерировать API Qooxdoo, даже если не все теги и комментарии верны?

Когда я попробовал generate.py api, у меня появилось много ошибок. Может ли генератор игнорировать эти ошибки?

== редактировать

Я сравнил Qooxdoo documentation standard с нашими кодирования/Spket стандартные документы.

Qooxdoo хочет документация параметров в стиле как

@param [name] {[type]} [description] 

и Spket имеет стиль

@param {[type]} [name] [description] 

даже разрывы строк между именем и описанием. Так что ошибки возникают.

Почему нет возможности игнорировать те недостающие ошибки имени параметра или даже предоставить другой формат?

== конец редактировать

Спасибо, эль

Answer 1

генератор останавливается, только если вы сделали ошибку в определении @param. Но только если вы не определяете имя параметра:

/** 
* bla bla 
* 
* @param {String} bla bla 
*/ 
test : function(test) { ... } 

В этом случае название «тест» отсутствует, генератор останавливается с ошибкой, как:

>>> Generating API data... 
    - Loading class docs... 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% 
    - Failed: Missing name of parameter., Line: 78, Column: 12 
!!! Error in API data of class: testapi.Application 
!!! Found erroneous API information. Please see above. Stopping! 

Просто добавьте недостающее имя (ошибка показывает строку в файле):

/** 
* bla bla 
* 
* @param test {String} bla bla 
*/ 
test : function(test) { ... } 

Теперь генератор не остановится, если вы проделали другую ошибку, как определение @return отсутствует, генератор создает API просмотра и ты будешь см. проблему при открытии программы просмотра API.

Answer 2

Конечно, поколение API всегда должен работать, даже если у вас нет одной вещи документированы. Поэтому ошибки чаще всего исходят из некоторых других обстоятельств. Возможно, вы должны опубликовать сообщение об ошибке, создаваемое генератором, чтобы мы могли устранить эту ошибку.

С уважением, Мартин