Anomalie #40
Doc incomplete
100%
Description
Description:
----------------------------------------
Si l'on cherche une fonction dans la doc de morphee et que l'on trouve cette
fonction, la doc ne permet pas, de maniere simple, de retrouver les fichiers à
inclure pour la compilation et le fichier à lier à l'edition de lien. C'est
pourtant des informations indispensables.
#2 05/12/2007 09:56 (Tibs)
---------------------------------------------------------------------------
Change: status: "pending" -> "accepted"
Comment:
Avoir les info sur le nom des header permettrait effectivement d'aller plus
vite, je vais tester les options proposées.
#1 30/11/2007 09:51 (jo)
---------------------------------------------------------------------------
Change: topic: "" -> "UI"
Change: solution: "" -> "Je connais peu doxygen mais au moins pour les include (ce qui me semble le plus important - les libs etant plus facile à trouver sans doc) il faut jouer avec FULL_PATH_NAMES STRIP_FROM_PATH et STRIP_FROM_INC_PATH. "
Change: title: "" -> "Doc incomplete"
Change: classification: "Bug" -> "Documentation"
Change: description: "" -> "Si l'on cherche une fonction dans la doc de morphee et que l'on trouve cette fonction, la doc ne permet pas, de maniere simple, de retrouver les fichiers à inclure pour la compilation et le fichier à lier à l'edition de lien. C'est pourtant des informations indispensables."
Updated by Serge Koudoro over 15 years ago
#3 comment 05/12/2007 13:33 (Tibs)
---------------------------------------------------------------------------
Comment:
J'ai testé les options proposées, mais ça ne répond pas vraiment au pb
malheureusement, car elles servent à spécifier le format des
adresses de fichier
lorsqu'elles sont affichées.
Le problème ici est de dire à Dowygen d'afficher les liens vers les
en-têtes où
se trouvent les prototypes des fonctions.
La solution (mauvaise) la plus proche consiste à activer
l'affichage des sources
(SOURCE_BROWSER = YES) en disant à Doxy de parser le contenu du
dossier /src et
non plus les en-têtes publiques. Ce n'est évidemment pas ce que
nous souhaitons
faire ici (car cela révèle plus que les prototypes des fonctions).
Apparemment Dowygen aime bien afficher l'endroit ou est défini un
symbole
("implémentée" dans le cas d'une fonction) mais je n'arrive pas a
lui dire de se
contenter de l'endroit ou le prototype seul est écrit...
Updated by Ali HASSAINE over 15 years ago
#6 comment 07/12/2007 16:52 (ali)
---------------------------------------------------------------------------
Comment:
Personnellement, je clique sur le fichier cpp dans lequel la
fonction est
définie (information fournie par la doc). Je vais en haut du
fichier cpp et là
il y a toutes les includes nécessaires.
#5 07/12/2007 16:51 (ali)
---------------------------------------------------------------------------
Comment:
Personnellement, je clique sur le fichier cpp dans lequel la
fonction est
définie (information fournie par la doc). Je vais en haut du
fichier cpp et là
il y a toutes les includes nécessaires.
Updated by Serge Koudoro over 15 years ago
#7 comment 07/12/2007 17:11 (Tibs)
---------------------------------------------------------------------------
Comment:
Attention, vous ne parlez pas des mêmes documentations:
- celle qui est en cause (et c vrai que ce n'était pas spécifié) est la
documentation de l'interface "C like" de Morph-M
- celle qui affiche le .cpp c'est la documenation "C++ générique"
qui donne
accès à l'ensemble du code, et n'est donc pas à mettre entre toute
les mains.
Bref: lorsqu'on travaille en interne, on peut effectivement se
référer à la doc
"générique" dans laquelle on retrouve entre autres les fonctions de
la doc "C
like".
Mais d'un point de vue "client" c'est vrai que le manque de
référence au bon
fichier dans la doc "C like" peut être vu comme un défaut.
Updated by Serge Koudoro over 15 years ago
- Category set to old plone Bugs
- Status changed from Nouveau to Résolu
- Priority changed from Normal to Bas
- % Done changed from 0 to 100