Go Down

Topic: EtherCard, la doc sans doc (Read 1 time) previous topic - next topic

skywodd

Salut tout le monde ^_^

A un moment (ça remonte à loin) avec plusieurs membres du forum on cherchaient une doc de la librairie EtherCard.
Et bien je viens de découvrir qu'il y en a une officielle ! Oui oui, officielle !

Je vous laisse découvrir la doc, ça vaut le coup d'œil :smiley-mr-green:
http://jeelabs.net/pub/docs/ethercard/classEtherCard.html

Maintenant vous devriez pouvoir utiliser EtherCard sans probléme ... ou pas :smiley-mr-green:
Des news, des tutos et plein de bonnes choses sur http://skyduino.wordpress.com !

timiti29

#1
Apr 24, 2013, 05:39 pm Last Edit: Apr 24, 2013, 05:43 pm by timiti29 Reason: 1
Merci à toi, Justement je vient juste de recevoir mon ENC28J60 et d'installer cette librairie.
Par contre, ce n'est pas vraiment une doc, il n'y a que les prototypes !
Moi je ne sais pas comment me servir d'une fonction si je ne sais pas a quoi elle sert !
J'espère qu'il vont modifier sa.
;)
Merci encore.
Timiti29

skywodd


Par contre, ce n'est pas vraiment une doc, il n'y a que les prototypes !
Moi je ne sais pas comment me servir d'une fonction si je ne sais pas a quoi elle sert !

Il y avait un petit côté ironique dans mon message ;)
Ce n'est clairement pas une doc, même moi j'y comprend rien et pourtant j'ai tenté de faire une doc par moi même fut un temps.
(doc qui s'est avéré complétement fausse au passage, j'avais compris les grandes lignes mais pas plus)


J'espère qu'il vont modifier sa.

Mon petit doigt me dit que le dév en a rien à péter de faire la doc :*
Des news, des tutos et plein de bonnes choses sur http://skyduino.wordpress.com !

68tjs

C'est un mauvais usage de Doxigen.
Le dev n'a même pas chercher à utiliser les balises de description.
Quote
Mon petit doigt me dit que le dév en a rien à péter de faire la doc

J'ai le mien qui pense la même chose : il s'est fait la doc dont lui avait besoin, point barre.

skywodd


C'est un mauvais usage de Doxigen.
Le dev n'a même pas chercher à utiliser les balises de description commentaires.

Tu avais fait une petite faute de frappe ;)
Il n'y a pas un seul commentaire que ce soit dans le code ou dans les entêtes.
Des news, des tutos et plein de bonnes choses sur http://skyduino.wordpress.com !

68tjs

Non non je n'ai pas fait de fote de phrape   :smiley-mr-green:

Vu l'écran  j'ai reconnu du Doxigen en action et j'attendais des balises :
@brief   -> description de ce que fait la fonction
@param -> description des paramètres à transmetre à la fonction
@return -> ce que retourne la fonction
@version
etc
etc

Par convention ces commentaires balises se mettent dans le fichier d'en tête mais Doxigen les trouve aussi si elles sont dans le fichier c ou cpp

skywodd

Oui oui j'avais bien compris ;)
Je faisait juste remarquer qu'en fait il n'y avait tout simplement aucun commentaires, doxygen ou autre.

Pour les doxydoc il faut les placer dans les entêtes de préférence, c'est là qu'on les trouves par convention.
(dans le .c/.cpp on met juste des commentaires d'implémentation et on "cache" dedans tout ce qui n'as pas à sortir sur la doc)
Des news, des tutos et plein de bonnes choses sur http://skyduino.wordpress.com !

Go Up