Pages: [1]   Go Down
Author Topic: EtherCard, la doc sans doc  (Read 1506 times)
0 Members and 1 Guest are viewing this topic.
France
Offline Offline
Faraday Member
**
Karma: 55
Posts: 5347
Arduino Hacker
View Profile
WWW
 Bigger Bigger  Smaller Smaller  Reset Reset

Salut tout le monde smiley-kitty

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
Logged

Des news, des tuto et plein de bonne chose sur http://skyduino.wordpress.com !

Offline Offline
Jr. Member
**
Karma: 0
Posts: 63
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

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.
smiley-wink
Merci encore.
Timiti29
« Last Edit: April 24, 2013, 10:43:21 am by timiti29 » Logged

France
Offline Offline
Faraday Member
**
Karma: 55
Posts: 5347
Arduino Hacker
View Profile
WWW
 Bigger Bigger  Smaller Smaller  Reset Reset

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 smiley-wink
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 smiley-kiss
Logged

Des news, des tuto et plein de bonne chose sur http://skyduino.wordpress.com !

68 aujourd'hui
Offline Offline
Edison Member
*
Karma: 41
Posts: 2260
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

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.
Logged

France
Offline Offline
Faraday Member
**
Karma: 55
Posts: 5347
Arduino Hacker
View Profile
WWW
 Bigger Bigger  Smaller Smaller  Reset Reset

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 smiley-wink
Il n'y a pas un seul commentaire que ce soit dans le code ou dans les entêtes.
Logged

Des news, des tuto et plein de bonne chose sur http://skyduino.wordpress.com !

68 aujourd'hui
Offline Offline
Edison Member
*
Karma: 41
Posts: 2260
View Profile
 Bigger Bigger  Smaller Smaller  Reset Reset

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
Logged

France
Offline Offline
Faraday Member
**
Karma: 55
Posts: 5347
Arduino Hacker
View Profile
WWW
 Bigger Bigger  Smaller Smaller  Reset Reset

Oui oui j'avais bien compris smiley-wink
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)
Logged

Des news, des tuto et plein de bonne chose sur http://skyduino.wordpress.com !

Pages: [1]   Go Up
Jump to: