Генерация qooxdoo api и игнорирование ошибок

Question

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

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

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

Я сравнил стандарт документации Qooxdoo с нашими стандартными документами по кодированию / spket.

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

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

и Спкет имеет стиль

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

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

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

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

Спасибо, эль

Answer 1

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

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

В этом случае имя для «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!

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

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

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

Answer 2

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

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