Bienvenue, Invité. Merci de vous connecter ou de vous inscrire.
Avez-vous perdu votre e-mail d'activation ?

Auteur Sujet: Proposer de générer un tagfile à la compilation  (Lu 1621 fois)

0 Membres et 1 Invité sur ce sujet

Papy Chacal

  • Newbie
  • *
  • Messages: 4
    • Voir le profil
    • E-mail
Proposer de générer un tagfile à la compilation
« le: Décembre 16, 2017, 05:22:49 pm »
Hello !

J'utilise et la SFML dans mes projets pour me faire un peu les dents, j'utilise aussi CMake et Doxygen pour mes projets, et en fouillant un peu, je suis tombé sur le mécanisme de tag file (cf https://www.stack.nl/~dimitri/doxygen/manual/external.html)

Du coup j'ai testé sur ma doc, et ça fonctionne : quand un type de la SFML est mentionné, dans ma doc, il est cliquable et mène à la documentation de la dite classe, générée lors de la compilation de la SFML.

J'ai du bidouiller le Doxyfile pour activer la génération et indiquer moi même le chemin du tag file.

Je trouverais ça sympa d'inclure une option (comme c'est déjà le cas pour la doc elle même) au CMakeLists.txt pour générer un tag file et eventuellement l'installer avec la doc ? Et peut-être d'ajouter des variables au module findSFML.cmake pour indiquer le dossier de la documentation installé le cas échéant et trouver le tag file ?

Ca permettrait de lier plus facilement les documentations des libraires utilisant CMake.

Ou peut-être que c'est trop accessoire ?

Merci de prendre le temps de considérer l'idée et bravo pour tout le boulot déjà fait !

Hiura

  • SFML Team
  • Hero Member
  • *****
  • Messages: 4328
    • Voir le profil
    • E-mail
Re: Proposer de générer un tagfile à la compilation
« Réponse #1 le: Décembre 16, 2017, 07:38:28 pm »
C'est vrai que c'est plutôt très spécifique comme demande... Après, faut voir, si c'est un changement trivial dont on parle qui ne nuit à personne, pourquoi pas. Je pense cependant qu'il serait bien d'éviter d'ajouter une option de plus. Si on génère ce tagfile systématiquement avec la doc, ça ne me dérangerait pas plus que ça personnellement.

Donc, de quel changement concret parle-t-on ?
SFML / OS X developer

Papy Chacal

  • Newbie
  • *
  • Messages: 4
    • Voir le profil
    • E-mail
Re: Proposer de générer un tagfile à la compilation
« Réponse #2 le: Décembre 17, 2017, 06:37:20 pm »
Oui, c'est clairement mineur comme changement : le fichier généré en question pèse ~500 ko, on ne sent pas la différence à la compilation non plus ! Et je ne vois pas à qui ça pourrait nuire, mais mon avis n'est pas franchement expert :P

Pour mettre une option ou non, j'ai plutôt envie de vous laisser réfléchir à ça, vous avez l'air de savoir ce que vous voulez !

Concrètement :

Il faut set l'option GENERATE_TAGFILE dans le doxyfile.in, en y indiquant le nom du fichier en question. (et éventuellement l'inclure dans la cible d'installation, si ce ne serait pas fait automatiquement)
Pour l'utiliser dans un autre projet, on a besoin du chemin de ce dit fichier et de la racine de la doc html générée.
Donc c'est là que ça peut être plus lourd, d'inclure la recherche des ces deux chemins dans le module findSFML.cmake, mais ça reste mineur.

Si vous préférez que je propose directement un patch ou autre chose, je ne connais pas bien ces choses là encore mais je peux m'y mettre à l'occasion :)

Hiura

  • SFML Team
  • Hero Member
  • *****
  • Messages: 4328
    • Voir le profil
    • E-mail
Re: Proposer de générer un tagfile à la compilation
« Réponse #3 le: Décembre 19, 2017, 10:25:36 pm »
Dans un premier temps, si on génère et installe ce fichier à côté de la doc HTML, ça me semble le mieux. Ainsi, les tags sont installés (en principe) dans un dossier prédéfini et standard. On peut voir plus tard si on a besoin de faire qqch de spécial avec FindSFML.cmake ou autre, mais pour l'heure ça me semble prématuré vu le peu de demande pour cette fonctionnalité.

Volontiers pour une PR, oui. Ça permettra aussi de recueillir l'avis d'autres personnes non francophone. :)
SFML / OS X developer

Papy Chacal

  • Newbie
  • *
  • Messages: 4
    • Voir le profil
    • E-mail
Re: Proposer de générer un tagfile à la compilation
« Réponse #4 le: Décembre 20, 2017, 12:07:37 am »
Ok je verrai ça un de ces quatre, merci pour les réponses :)

Papy Chacal

  • Newbie
  • *
  • Messages: 4
    • Voir le profil
    • E-mail
Re: Proposer de générer un tagfile à la compilation
« Réponse #5 le: Décembre 26, 2017, 10:20:44 am »
Pull Request posté :
https://github.com/SFML/SFML/pull/1327

J'ai loupé quelque chose ou tout va bien ? J'imagine que la discussion se continue plutôt sur GitHub à partir de là ?