Documentation Doxygen

Bjr

J aimerais savoir qui s occupe de generer la doc sous doxygen ?

Merci

Je ne sais pas.
Mais hier, c’était la v7, et aujourd’hui la v9:
https://doxygen.dolibarr.org/index.html

Bonjour !

Pour rapidement générer la doc (je ne pense pas que ça soit la façon la plus ‹ dolibarr › de faire, mais ça marche) :

Pré requis Debian & dérivés, sachant que ces paquets sont à peu près nommés pareils dans les autres distribs :

[email protected] : aptitude install graphviz doxygen

Génération de la documentation

[email protected] : cd ~/dolibarr/build/doxygen
[email protected] : doxygen dolibarr-doxygen.doxyfile

La génération est dispo dans :

[email protected] : ~/dolibarr/build/html/index.html

Testé avec succès :

Génération HTML : oui
Génération Latex ou RTF : non (testé)

Bricoler les options dans dolibarr-doxygen.doxyfile permet d’avoir plus ou moins de fonctionnalités, voire plus de fonctionnalités que la version sur le site, y compris une recherche ajax plutôt jolie :happy:

Have fun !

Stéphane

Salut Stéphane

Est ce possible de generer du pdf ?

Ta methode necessite t elle eclipse ?

Merci du 17 :wink:

Le 17 parle au 17, donc :happy:

Pour le PDF, pas creusé, trouvé dans le fichier de conf de doxygen qu’on pouvait générer du Latex (donc du DVI) ou du RTF. J’ai testé, ça n’a rien donné (soit ça plante pour le DVI, soit ça donne un RTF pourri). Du DVI, on peut passer au PDF. J’en suis resté la.

Non, Eclipse, je ne supporte pas. Ici, pour Dolibarr, c’est Netbeans. Mais pour générer la doc, je n’ai indiqué que quelques commandes à lancer dans un terminal…

Tu es sous quoi ?

Bonjour :happy:
Il faudrait mettre à jour la doc je pense (c’est la v9 en ligne) :
https://doxygen.dolibarr.org/

J’ai réussi à la générer en local pour la branche de dév. Cela fonctionne bien.

Je pense que cela serait une bonne chose d’avoir en ligne la dernière version de chaque branche pour les branches supportées (les 3 ou 2 dernières je ne sais plus trop) et la branche develop (branchée en intégration continue ou cron pour qu’elle soit regénérée chaque nuit par exemple).

1 J'aime

Bonjour :happy:
Oui se serait top…@eldy? :whistle:

Voilà, c’est en ligne ici https://doxygen.dolibarr.org

La doc est dispo pour la branche de développement (develop et les branches 10.0, 9.0, 8.0 et 7.0).

La recherche et les diagrammes d’héritage et de collaboration sont de nouveau disponibles :wink:

C’est re-généré automatiquement de façon hebdomadaire.

Le format PDF est également disponible au téléchargement si besoin.

Pour les curieux, cela utilise TravisCI et GitHub Pages : voir https://github.com/Dolibarr/dolibarr-doxygen

6 J'aimes

Bonjour :happy:
Trop fort!!!
merci c’est génial!

Bonjour,
Tu mérites un trophée.

Salut,

Ça sert à quoi ? :lol:

(je rappelle que je ne suis pas dev donc désolé pour cette question bête :wink: )

j’avoue bravo! cela mérite un dolibarr d’Or :wink:

c’est une documentation technique qui permet de chercher rapidement dans le code; une sorte de lexique en gros

Doxygen est un générateur de documentation. C’est un logiciel qui se base sur le code source d’un logiciel (et les commentaires et annotations qui l’accompagne) pour générer une documentation à partir de ces données dans différents formats (html, rtf, pdf, etc.).

Cela permet aux développeurs Dolibarr mais surtout aux développeurs de modules tiers de rechercher facilement une fonction du core (à partir de son nom) en utilisant le moteur de recherche pour avoir les données qui y sont associées : quel est l’objectif de la fonction, quels sont les paramètres qu’elle prend en entrée, que retourne t’elle en sortie ? Les variables de classes et les constantes sont aussi disponibles. Cela permet aussi de voir graphiquement les relations d’héritage entre les différentes classes (quelle classe hérite d’une autre : classes enfants et classes mères, implémentation des classes abstraites, etc.)

1 J'aime

:laugh: Merci

oui, j’ai vu la représentation graphique, c’est pédagogique :happy:

et tout ça est généré dynamiquement depuis github ??

chapeau bas Jtraulle !

voilà pour toi :

5 J'aimes

Ouaip, c’est bien ça (et la doc générée est hébergée sur GitHub) :tongue:

1 J'aime

Bonjour :slightly_smiling_face:
Sur doxygen la v11 n’est pas disponible

C est la version develop non ?