Delphi + JavaDoc = DelphiCodeToDoc [Trucs & Astuces]

**trident_job** · 29/09/2004, 13h46

Donc dans le cas où je souhaite avoir, dans une arborescence, 2 fois ou plus le même fichier unité cela n'est pas possible. Je reconnais que ce n'est pas d'un usage courant
Je suppose que dans ta structure de données, la construction de l'unicité de chaque classe ne prend pas en compte le nom de fichier et/ou le nom de répertoire.

C'est exact.
DCTD doit être utilisé sur un projet Delphi, et par définition, tu ne dois pas avoir deux unités avec le même nom.

**Laurent Dardenne** · 29/09/2004, 16h42

Merci.
Bon et bien maintenant je le sais

**trident_job** · 29/09/2004, 19h59

Le commentaire de la procédure SetLockTable se retrouve dans le commentaire de la propriété FOnDecompressBLOB.

Oui, il y a effectivement un problème. DCTD semble ne pas bien reconnaître les '///' en inline après une méthode. Je vais investiguer, et corriger pour la prochaine version.

Juste un point en parlant de ça. Seule une méthode sans paramètre, ni type de retour (procedure donc) peut, théoriquement, bénéficier de ce inline. Sinon, il faut documenter avec les JavaDoc, et donc créer une section complète de commentaire ...

D'accord, je chipotte

(comme dirais les Belges!).

**Laurent Dardenne** · 29/09/2004, 21h58

Envoyé par trident_job

Sinon, il faut documenter avec les JavaDoc, et donc créer une section complète de commentaire ...

Merci, je ne connais pas encore les finesses du soft mais petit à petit ça commence à rentrer 8)
Je regarde cette maniére de faire.

Utilises-tu un source de référence qui contient toutes les possibilités du soft, pour les tests de non regression ?
Et si oui pourquoi ne pas le mettre dans la distribution, comme exemple ?

**trident_job** · 01/10/2004, 21h29

Utilises-tu un source de référence qui contient toutes les possibilités du soft, pour les tests de non regression ?

J'utilise DUnit pour les tests unitaires, et des fichiers de reférence pour l'ensemble. Mais aujourd'hui, c'est encore bordélique et peu commenté.
Mais cela viendra ! :o

**jfd** · 10/10/2004, 11h24

2 problèmes :
- une unité répété 2 fois ?
(j'en ai bien qu'une ! sur tout le disque dur )
- le nom d'une fonction modifié ? de 'Logger' => j'ai 'Loger' ?
- sur la liste des fonctions/procédures (avant l'implementation)
seul la 1ère apparait (log[g]er ) ?

voila
a+

**trident_job** · 10/10/2004, 12h07

Bonjour JFD,

Peux-tu m'expliquer exactement ton problème dans un style moins télégraphique.

Si je comprends bien, tu as ces deux problèmes :

* une unité qui est répétée deux fois dans la doc, alors que tu n'as physiquement qu'un fichier ?
* Ensuite, une fonction appelée Logger dans ton code se transforme en Loger dans la doc générée ?

Envois-moi ton répertoire projet, sur lequel tu demande à générer ta documentation, comme cela, je pourrais diagnostiquer au mieux.

**jfd** · 12/10/2004, 19h21

c'est exactement cela !

de plus, sur l'ensemble des procedures/fonctions présent
dans la partie interface, il ne trouve que "Loger" ?

...

**trident_job** · 13/10/2004, 07h55

Cela parait vraiment surprenant.
Il me faudrait un extrait de ton code, ou ton répertoire complet si c'est possible.
Sinon, je peux difficilement t'aider. Utilises-tu la versoin v0.9b ?

**Benjamin GAGNEUX** · 13/10/2004, 12h32

J'utilise DelphiCodeToDoc depuis peu .... et j'en suis très content !

En effet, étant ancien programmeur Java, j'ai eu beaucoup de mal à apprécier Delphi (

). Comme je suis analyste-programmeur indépendant, j'ai souhaité me tourner vers Delphi surtout pour son système RAD (qui n'était pas aussi complet sous java à l'époque).
Mais parfois, je suis un peu nostalgique et je repense au Java, ses différentes possibilités dont entre autre la JavaDoc.

Et la ! Chapeau, je crois que tu viens de me réconsillier avec Delphi en ayant réalisé DelphiCodeToDoc.

De plus cela fonctionne à merveille !!! Vraiment un grand

pour cette utilitaire qui comble une lacune de Delphi.

Et j'apprécie énormément la mise sous licence GNU-GPL

Merci d'avoir réaliser ce que tout le monde espèrait trouver sous Delphi.

**trident_job** · 13/10/2004, 13h29

Envoyé par yobenzen

J'utilise DelphiCodeToDoc depuis peu .... et j'en suis très content !
...
Et la ! Chapeau, je crois que tu viens de me réconsillier avec Delphi en ayant réalisé DelphiCodeToDoc.
De plus cela fonctionne à merveille !!! Vraiment un grand

pour cette utilitaire qui comble une lacune de Delphi.
Et j'apprécie énormément la mise sous licence GNU-GPL

Merci d'avoir réaliser ce que tout le monde espèrait trouver sous Delphi.

Salut !
TOn message me fait chaud au coeur, et me motive d'autant plus !
Si jamais un jour je manque de motivation, je viendrais relire ton message

!

Concernant la licence GNU-GPL, j'ai énormement appris des gens qui m'ont fait des remarques sur le code, en plus de la joie de partager un travail qui peut (eventuellement) servir d'exemple pour d'autre programmeur, même si c'est loin d'être un modèle. J'apprécie moi même de trouver des logiciels open-source, j'essaie donc de contribuer un petit peu !
J'espère que l'évolution de DelphiCodeToDoc continuera de répondre à tes attentes.

Et si tu as des besoins particuliers, des remarques, des bugs etc ... n'hésites pas à m'en faire part, par mail ou directement sur le site.

TridenT.

**Benjamin GAGNEUX** · 13/10/2004, 13h45

Envoyé par trident_job

Concernant la licence GNU-GPL, j'ai énormement appris des gens qui m'ont fait des remarques sur le code, en plus de la joie de partager un travail qui peut (eventuellement) servir d'exemple pour d'autre programmeur, même si c'est loin d'être un modèle. J'apprécie moi même de trouver des logiciels open-source, j'essaie donc de contribuer un petit peu !

Bien dit !
C'est comme cela que l'on arrive à des logiciels fiables, gratuits et distribuables pour le bonheur de tous...
Et c'est en s'entraidant chacun que l'on arrive a de grande chose.

Concernant les bugs :
Je n'en ai rencontré qu'un, il s'agit de l'utilisation @Return sur un record. Mais je crois que ce sujet a déjà été abordé sur ton site (

Je ne suis pas très doué en Anglais).

Encore merci !

**jfd** · 23/10/2004, 15h29

Salut

Désolé pour mes remarques, ça vient de moi !

des vieux bout d'unités qui ne faisaient plus parti du projet, mais qui trainaient encore dans le dossier du projet ...
En fait ton outil m'a fait faire du ménage

Sinon DelphiCodeToDoc est vraiment sympa

a+

**trident_job** · 23/10/2004, 16h46

En fait ton outil m'a fait faire du ménage

Parfait ! 8)

Sinon DelphiCodeToDoc est vraiment sympa

Merci! C'est surtout grâce aux remarques et commentaires de tous les utilisateurs !

**Xander** · 09/11/2004, 10h21

Bonjour à tous

j'utilise DelphiCodeToutDoc depuis plusieurs mois déjà.
Je le trouve très pratique et surtout très utile.

L'inconvégnant majeur est le nombre de fichier généré et la taille des fichiers.

J'ai trouvé un autre logiciel qui me permet de transformer tous ces fichiers en un fichier ".chm". (fichier d'aide windows)

le logiciel en question est : "HTML help work"

j'aimerais savoir s'il y a un moyen de lancer ce logiciel directement après avoir lancé DCTD.

:

Merci d'avance

**trident_job** · 09/11/2004, 11h16

Salut.
le fait de transformer les html en CHM permet effectivement de :
* Compresser le HTML (donc de gagner de la place)
* de n'avoir qu'un seul fichier .CHM
* de bénéficier du module de recherche du format CHM.

J'avais prévu d'ajouter cette fonctionnalité

, mais repoussée pour l'instant par manque d'expérimentation. Je ne suis pas sûr que la génération du CHM soit si automatique que cela, il faut construire des index, des références etc ... bref, si tu as une façon de faire automatiquement, cela m'interresse evidement !

Pour ton soucis, tu peux utiliser un fichier BATCH et lancer DCTD en ligne de commande, puis ton constructeur de CHM.

Le programme que tu utilises est-il HTML Help Workshop

:

Dans tout les cas, je garde cette fonctionnalité pour une des prochaines versions, il faut juste que je teste la génération du CHM.

merci pour la remarque et les compliments.

TridenT

**Xander** · 10/11/2004, 08h28

bonjour

J'aurais souhaité savoir ce que tu entendais par "lancer DCTD par ligne de commande".
Suggères tu simplement un fichier batch dans lequel on lancerais DCTD puis "html help workshop".

Est il possible de générer l'ensemble des fichiers directement par ligne de commande

:

Merci d'avance

Xander

**trident_job** · 10/11/2004, 13h56

J'aurais souhaité savoir ce que tu entendais par "lancer DCTD par ligne de commande".

Le fichier DCTD_cmd.exe se lance uniquement en ligne de commande, contriarement à DelphiCodeToDoc.exe qui contient le programme + l'IHM de configuration.

Suggères tu simplement un fichier batch dans lequel on lancerais DCTD puis "html help workshop".

hé bien oui

J'ai travaillé hier soir sur le sujet, et je peux te dire que le format CHM sera supporté dans la version v0.11b (jusqte après la v0.10b de demain donc) !

En espérant que cela résolve te sproblèmes.
TridenT

**Laurent Dardenne** · 10/11/2004, 13h58

Salut,
peux-tu nous communiquer une date de mise à dispo pour la prochaine version ?
[edit]
Croisement de post

[/edit]

**trident_job** · 10/11/2004, 15h40

laurent, la prochaine version v0.10b sort demain (11 novembre).
Il y a eu bcq de retard dû aux traductions exotiques et aux tests d'intégration (et de non regression) qui sont automatisés avec DUnit...

Voici un aperçu des nouveautés, en Anglais, désolé.

-------------------------------------------------------

Added "Todo TAG" support

Added "Output Member Filtering" option to show/hide some categories (Tracker 997979)

Fixed "Directories not exists" Exception (Tracker 1058399)

Fixed Menu and toolbar not disabled when Parsing and building (Tracker 1035514)

Fixed "Warn when empty TAG" function not working (Tracker 1035953)

Improved empty TAG handling

Added Extended Comment support with @Comment TAG

Added Extended Comment support TAG with DoubleSlash in methods

Improved Multiline TAG recognition.

Updated Translations template

Added Russian Translation (Tracker 1036934)

Change cursor to "occupied cursor" when building the HTML project (Tracker 1035514)