Documentation développeur

[olivier]

• Documentation du code (60%)
• Documentation des plugins
• Référence des behaviors
• Référence du service REST

[olivier]

Milestone 2.0f deleted

[franck]

Avec la mise en place de Doxygen et tout le boulot fait côté Wiki, on a déjà pas mal, non ? Moe, toi qui a probablement la meilleure vision globale de ça, t'en penses ?

[Moe]

Ça dépend quel niveau d'exigence on fixe. :)

Si je reprends les points d'Olivier :

• Documentation du code : il doit subsister des fonctions non documentées
• Documentation des plugins : elle est suffisamment complète pour commencer un plugin et ajouter quelques options
• Référence des behaviors : certains ont été ajoutés au fur et à mesure des versions mais sont absents de la documentation
• Référence du service REST : je ne vois pas de quoi ça parle

[Tomtom33]

C'est vrai que la documentation des behaviors est en retard. Il faudrait trouver un moyen efficace de pouvoir rajouter les nouveaux behaviors au wiki lors du build.

Concernant les services REST, ce sont les services ajax pour les plugins dont je parle  ici ;)

[kozlika]

C'est çui qui dit qui y est :-P

Tu te penches sur cette histoire de doc, Tomtom33 ?

[Tomtom33]

Replying to kozlika:

C'est çui qui dit qui y est :-P

Tu te penches sur cette histoire de doc, Tomtom33 ?

Bah je veux bien mais je vois pas techniquement comment faire. Il me semble que le build génère déjà un fichier formaté en wiki de tous les behaviors. Il faudrait donc récupérer ce fichier, faire un merge avec la version que l'on a sur le wiki puis mettre à jour.

Mais comme je le disais, je ne sais pas comment faire tout ça à partir du build :P

[Tomtom33]

Bon, je vais quand même me pencher sur cette histoire de doc des behaviors