生成qooxdoo api並忽略錯誤

即使並非所有標記和註釋都正確，是否可以生成Qooxdoo API？生成qooxdoo api並忽略錯誤

當我試着generate.py api我得到了很多錯誤。生成器可以忽略這些錯誤嗎？

==編輯

我比較了Qooxdoo documentation standard與我們的編碼/ spket標準文檔。

想要的Qooxdoo參數的文檔樣式像

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

和Spket有風格

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

即使名稱和描述之間換行符。所以錯誤發生。

爲什麼不可能忽略那些缺失的parametername錯誤或甚至提供其他格式？

==結束編輯

感謝， EL

來源

2010-08-18 elCapitano

如何重新格式化@param定義？如果格式不正確，我不能使用spket進行格式化。 – elCapitano 2010-08-19 11:04:24

發電機僅當您在@param定義做了一個錯誤停止。但是，只有當你不定義參數名：

>>> 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 {String} bla bla 
*/ 
test : function(test) { ... }

在這種情況下爲「測試」的名稱丟失，發電機之類的錯誤停止（錯誤顯示您的文件中的行）：

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

現在發電機不會停止，如果你做了其他的錯誤，像@返回定義缺失，發電機產生的API瀏覽器和你會在打開API查看器時看到問題。

來源

2010-08-19 08:56:29

肯定的是，API應該總是工作，即使你沒有一個單一的東西記錄的產生。所以這些錯誤大多來自其他一些情況。也許你應該發佈生成器生成的錯誤消息，以便我們可以避免這種錯誤。

的問候，馬丁

來源

2010-08-18 11:08:43

生成qooxdoo api並忽略錯誤

回答

相關問題