H\u00e9 bien ces temps-ci mon blog croule sous les articles, va falloir que je me calme moi\u2026 non ? Bon, je vais donc vous parler de mon dernier n\u00e9, qui incube quand-m\u00eame depuis un moment\u2026<\/p>\n
Une petite histoire\u2026 tout commence il y a bien longtemps, du temps o\u00f9 l’ann\u00e9e s’\u00e9crivait encore 2009. En ces temps recul\u00e9s donc, et en grand amateur de documentation fra\u00eeche et bien form\u00e9e1<\/sup><\/a>, l’id\u00e9e d’\u00e9crire un plugin<\/em> pour cet EDI2<\/sup><\/a> sympathique qu’est Geany<\/a> qui faciliterai la r\u00e9daction de la documentation d’un code source germa dans mon esprit. Ni d’une ni de deux, je m’att\u00e8les \u00e0 la t\u00e2che. Sauf que je me rends compte rapidement que le design<\/em> de mon plugin<\/em> est tout sauf le bon. Je voulais quelque-chose d’extensible : c’est on ne peut plus ferm\u00e9. Je voulais quelque chose qui g\u00e8re facilement \u00e0 peu pr\u00e8s n’importe quel langage de programmation : c’est tout sauf le cas. Je voulais quelque-chose qui soit \u00e0 peu pr\u00e8s ind\u00e9pendant du format de documentation : que nenni ! J’arr\u00eate donc les efforts inutiles, et me penches sur un design<\/em> plus adapt\u00e9\u2026 mais, et c’est ce qui va me perdre, j’ai quand-m\u00eame d\u00e9j\u00e0 quelque-chose qui fonctionne relativement bien pour mes besoins.<\/p>\n Et donc, le temps passe et j’oublie un peu mon devoir d’am\u00e9liorer ce design ; et ceci est, je l’avoue volontiers, en grande partie d\u00fb au fait que le mauvais plugin<\/em> fonctionnait trop bien, satisfaisant la majorit\u00e9 de mes besoins. Le temps passe donc, et je ne r\u00e9fl\u00e9chis que distraitement \u00e0 ce nouveau design<\/em>.<\/p>\n Mais, bien-entendu, arrive un moment o\u00f9 je trouve une id\u00e9e qui me para\u00eet adapt\u00e9e \u2014 l’avenir nous le dira \u2014 et je commences donc \u00e0 l’impl\u00e9menter. Mais ha ha, je me heurtes \u00e0 un l\u00e9ger probl\u00e8me\u00a0: j’ai besoin d’un moteur de template<\/em> qui permet d’utiliser des boucles et autres tests. J’ai beau chercher de-ci de-l\u00e0, rien (en C) ne semble correspondre \u00e0 mes besoins. Car en plus je suis difficile, et ne veux pas avoir \u00e0 appeler un programme externe mais pr\u00e9f\u00e8re une biblioth\u00e8que, et si elle permettait de traiter des donn\u00e9es directement en m\u00e9moire, \u00e7a serait encore mieux. Et c’est ainsi qu’est n\u00e9 ce fameux CTPL<\/a> dont je vous parle tout le temps.<\/p>\n Et donc me voici en train d’\u00e9crire CTPL, mettant \u00e0 nouveau en pause le plugin<\/em> lui-m\u00eame. Quelques mois passent tranquillement sans en avoir l’air\u2026 et finalement, CTPL arrive \u00e0 un stade qui semble utilisable.<\/p>\n Me revoici donc \u00e0 impl\u00e9menter ce plugin<\/em> nouveau, chose enfin possible ! Et les choses se passent tranquillement, entre \u00e9criture et changement de certaines choses dans CTPL, pour arriver finalement au stade actuel : \u00e7a marche plut\u00f4t bien, et le design<\/em> me semble plut\u00f4t sympathique.<\/p>\n Et me voici enfin \u00e0 pr\u00e9senter ce plugin<\/em>, le simplement nomm\u00e9 GeanyGenDoc<\/em>.<\/p>\n GeanyGenDoc<\/em> est sens\u00e9 faciliter la r\u00e9daction de la documentation d’un code source. Son r\u00f4le est de pr\u00e9parer le terrain pour recevoir ce qui est vraiment utile, c’est \u00e0 dire les descriptions et autres explications. Il g\u00e9n\u00e8res donc, \u00e0 la demande, un commentaire de documentation vide adapt\u00e9 \u00e0 ce qu’il documente. Par exemple, il pr\u00e9parera un commentaire de fonction Doxygen<\/a> en ins\u00e9rant automatiquement la liste des param\u00e8tres : il ne reste plus qu’\u00e0 remplir les descriptions. \u00c9videmment, on peut en faire autant avec les structures, les \u00e9num\u00e9rations, les variables, et c\u00e6tera<\/em>.<\/p>\n GeanyGenDoc<\/em> a \u00e9t\u00e9 con\u00e7u pour \u00eatre \u00e0 peu pr\u00e8s compl\u00e8tement extensible ; ce qui fait que la majeur partie des choses sont configurables :<\/p>\n J’en oublie sans doutes, mais voici les choses principales. S’il me fallait citer un inconv\u00e9nient \u00e0 ce design<\/em>, je pense que je dirais que son d\u00e9faut vient de son extensibilit\u00e9 et de sa jeunesse : il faut \u00e9crire la plupart des r\u00e8gles de documentation car tr\u00e8s peu sont fournies par d\u00e9faut. Pour le moment il n’y a que GTK-Doc<\/a> en C qui soit g\u00e9r\u00e9 plut\u00f4t correctement par d\u00e9faut, et une petite partie de Doxygen. Mais des r\u00e8gles pour d’autres langages ou formats de documentation seront probablement int\u00e9gr\u00e9es par d\u00e9faut au fur et \u00e0 mesure.<\/p>\n GeanyGenDoc n’a encore aucune version publi\u00e9e, mais la version de d\u00e9veloppement se trouve dans le d\u00e9p\u00f4ts de plugins<\/em> de Geany<\/a>, Geany-Plugins. Amusez-vous, documentez, rapportez des bugs et fournissez des patchs !<\/p>\n Vous pouvez acc\u00e9der au d\u00e9p\u00f4t avec SVN<\/a> : Et m\u00eame avec Git<\/a> directement (sans m\u00eame avoir besoin de git-svn) : H\u00e9 bien ces temps-ci mon blog croule sous les articles, va falloir que je me calme moi\u2026 non ? Bon, je vais donc vous parler de mon dernier n\u00e9, qui incube quand-m\u00eame depuis un moment\u2026 Une petite histoire, \u00e7a vous dit ? Une petite histoire\u2026 tout commence il y a bien longtemps, du temps o\u00f9 … Continuer la lecture de Lancement (officiel) de GeanyGenDoc<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5,6],"tags":[],"class_list":["post-185","post","type-post","status-publish","format-standard","hentry","category-informatique","category-logiciels-libres"],"_links":{"self":[{"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/posts\/185","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/comments?post=185"}],"version-history":[{"count":0,"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/posts\/185\/revisions"}],"wp:attachment":[{"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/media?parent=185"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/categories?post=185"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ban.netlib.re\/blog\/wp-json\/wp\/v2\/tags?post=185"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}GeanyGenDoc, enfin !<\/h3>\n
C’est quoi ?<\/h4>\n
Les fonctionnalit\u00e9s et le reste<\/h4>\n
\n
Se procurer GeanyGenDoc<\/h4>\n
\nsvn co https:\/\/geany-plugins.svn.sourceforge.net\/svnroot\/geany-plugins\/trunk geany-plugins<\/code><\/p>\n
\ngit clone http:\/\/git.geany.org\/git\/geany-plugins<\/code><\/p>\nQuelques liens<\/h3>\n
\n
Notes<\/h3>\n
\n