2010-08-18 4 views
1

모든 태그 및 주석이 정확하지는 않더라도 Qooxdoo API를 생성 할 수 있습니까?qooxdoo API 생성 및 오류 무시

내가 시도했을 때 generate.py api 나는 많은 오류가 발생했습니다. 발전기가 이러한 오류를 무시할 수 있습니까?

== 편집 나는 우리의 코딩/spket 표준 문서와 Qooxdoo documentation standard을 비교 하였다.

Qooxdoo 매개 변수의 문서

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

같은 스타일을 원하고 Spket 심지어 이름과 설명 사이에 줄 바꿈과 스타일

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

있습니다. 그래서 오류가 발생합니다.

누락 된 매개 변수 이름 오류를 무시하거나 다른 형식을 제공 할 가능성이없는 이유는 무엇입니까?

== 최종 편집

감사합니다, 엘

+0

어떻게 @param 정의를 다시 포맷 할 수 있습니까? 포맷이 올바르지 않으면 포맷팅을 위해 spket을 사용할 수 없습니다. – elCapitano

답변

1

발전기는 정지합니다. 당신이 매개 변수의 이름을 정의하지 않은 경우에만 그러나 :

>>> 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) { ... } 

누락 된 @return 정의처럼 타 실수를했을 경우 발전기가 정지하지 않습니다, 발전기는 API를 생성 뷰어 ​​및 너는 API 뷰어를 열 때 문제가 표시됩니다.

1

물론, 항상 당신이 한 일이 기록이없는 경우에도 작동해야 API의 생성. 오류는 대부분 다른 상황에서 발생합니다. 어쩌면 우리는 그 오류를 얻을 수 있도록 발전기가 생산하는 오류 메시지를 게시해야합니다. 당신이 @param 정의에 의해 오류를 수행 한 경우

안부, 마틴