Générer qooxdoo api et ignorer les erreurs

Question

est-il possible de générer une API Qooxdoo même si tous les tags et commentaires ne sont pas corrects? Quand j'ai essayé generate.py api j'ai eu beaucoup d'erreurs. Le générateur peut-il ignorer ces erreurs?

modifier ==

j'ai comparé la norme Qooxdoo documentation standard avec notre codage/Spket docs.

qooxdoo veut la documentation des paramètres de style comme

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

et Spket a le style

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

même avec des sauts de ligne entre le nom et la description. Donc, les erreurs occour.

Pourquoi n'y a-t-il aucune possibilité d'ignorer ces erreurs de nom de fichier manquantes ou même de fournir un autre format?

modifier fin ==

Merci, el

Answer 1

le générateur arrête que si vous avez fait une erreur par la définition @param. Mais seulement si vous ne définissez pas le nom du paramètre:

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

Dans ce cas, le nom de « test » est manquante, le générateur arrête avec une erreur comme:

>>> 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! 

il suffit d'ajouter le nom manquant (l'erreur vous montre la ligne dans le fichier):

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

maintenant, le générateur ne s'arrête pas, si vous avez fait une autre erreur, comme une définition de @return manque, le générateur crée l'API Viewer et vous serez voyez le problème lorsque vous ouvrez l'API Viewer.

Answer 2

Bien sûr, la génération de l'API devrait toujours fonctionner, même si vous ne disposez pas d'une seule chose documentée. Donc, les erreurs proviennent le plus souvent d'autres circonstances. Peut-être que vous devriez poster le message d'erreur que le générateur produit afin que nous puissions obtenir cette erreur à l'écart.

Cordialement, Martin