Delphi + JavaDoc = DelphiCodeToDoc [Trucs & Astuces]

Pour info dans mon dernier message je pensais que la possibilité de générer de la doc sous Delphi 2005 était aisée ...

C'est pas vraiment le cas pour les pré-requis :

The XMLDoc tool requires a number of supporting tools:
- Delphi 2005
- Python (tested with Python 2.3)
- Saxon (tested with Instant Saxon 6.5.3)
- The Java SDK (tested with J2SE v 1.4.2_05 SDK)

Envoyé par sovitec

J'ai découvert 2 bugs que j'ai rajouté au tracker de façon anonyme

Merci d'avoir rajouté ces Trackers, je vais vérifier et corriger au plus tôt.
Si tu as d'autres bugs ou souhaits, n'hésites pas

Envoyé par eponette

Il y a un petit truc pratique avec Javadoc qui manque. c'est le link. C'est pratique dans le texte de faire référence directement à une autre classe/propriété/methode...

Donc pour une future version...

Oui, j'avais prévu d'ajouter le TAG @see pour la prochaine version, mais j'avais mis de coté le @Link.
J'essayerai de l'ajouter en même temps, mais je ne promet rien, j'ai une longue liste de reste à faire :o !
Voici le lien vers le Tracker que je viens de rentrer.
http://sourceforge.net/tracker/index...81&atid=614258
Merci pour l'info !

Envoyé par Laurent Dardenne

Pour info dans mon dernier message je pensais que la possibilité de générer de la doc sous Delphi 2005 était aisée ...

C'est pas vraiment le cas pour les pré-requis :

Oui, effectivement, c pas si simple
C'est un aspect que je n'avais pas encore regardé, je me concentre sur l'avancée d'une v1.0 stable

Si tu as d'autres infos sur le sujet (un exemple + résultat), je suis preneur !

Chers utilisateurs de DCTD,

à travers cette note, je voudrais vous informer du développement de l'application DelphiCodeToDoc. La dernière version publique, la v0.13b, date du 22/06/2005 ... plus de trois mois.
Alors, que-ce passe-t-il ? Y aura-t-il d'autre versions ? Si oui, quelles seront les nouveautés ?
J'anticipe les questions, et voici quelques explications.

Tout d'abord, il faut savoir que je développe DelphiCodeToDoc de manière tout à fait personnelle, je ne fais pas ce logiciel dans le cadre d'une société, donc c'est mon temps libre qui dirige le planning du développement.
En ce moment, j'ai beaucoup de mal à trouver du temps, je dois passer 1 à 2 heures par semaine tout au plus.
Je vous rassure donc, le développement n'est pas arrêté, il reste une quantité non négligeable de Trackers à corriger.
Si vous jetez un oeil dans le repository CVS ( http://cvs.sourceforge.net/viewcvs.py/dephicodetodoc ) vous verrez que je commit régulièrement des versions. DelphiCodeToDoc vit !

Je travaille en ce moment sur la syntaxe dotNet de Delphi, qui me pose pas mal de problèmes. J'ai dû revoir certains points dans l'architecture pour répondre correctement à ce point là, ce qui m'a pris pas mal de temps. Le but est de finaliser une version qui prenne en charge les types imbriqués, les variables et constantes de classes, les classes "helper" , la surcharge des opérateurs etc ...
Cette fonctionnalité est finie a environ 70%, le reste ne devrait pas prendre trop de temps.
La version prochaine (v0.14b) va donc répondre au besoin de documenter des codes utilisant la syntaxe dotNet, en plus de la correction de bug recensés (10 sur les 13 actuels). http://sourceforge.net/tracker/?atid=614255&group_id=96281&func=browse
Cette version devrait être finalisée d'ici la fin du mois au plus tard. Je prends aussi du temps pour écrire des tests avec DUnit ce qui m'aide dans la recherche des régressions.

Pour les versions futures, voici en gros la roadmap pour la version suivante v1.0 (enfin)
* Correction des bugs restants.
* Lien HTML sur les parents de chaque objet de la documentation
* Support du TAG @Link et @See
* La mise à jour complète des traductions
* Ajout du choix de la langue de la Documentation générée
* Fichier de configuration au format XML


Voila, vous savez à présent quelle direction prend DelphiCodeToDoc, je vous demande juste un peu de patience.
Je voudrais profiter de l'occasion pour remercier toutes les personnes qui ont participé au développement, par leur remarques, leurs idées, leur traductions et parfois leur soumission de code.
Merci à tous de votre aide, j'adore l'ambiance de la communauté Delphi, et j'ai appris beaucoup grâce à vous. Encore Merci !

TridenT

Salut Bruno75,

tu devrais pondre un fichier xml qui résulte du parsing de ton fichier

Oui, j'y ai pensé recemment, mais je suis encore novice dans la transformation XML pour généré du HTML par exemple. Mais je vais y regarder de plus près, vu que je voudrais travailler sur des "templates" pour générer la documentation.

Quand à antlr, je connais pas, je vais jeter un coup d'oeil.
Merci !

ANN: DelphiCodeToDoc v0.14Beta disponible - Outil gratuit de generation de documentation pour Delphi

La dernière version de DelphiCodeToDoc (v0.14Beta) est disponible. Elle peut être téléchargée ici :

http://prdownloads.sourceforge.net/dephicodetodoc/DelphiCodeToDoc_exe_v0.14b.zip?download

Situation : Cette version supporte (enfin) la syntaxe dotNET de Delphi2005 (et certaine de Delphi2006)

-----------------------------------------------------------------
Quelles sont les nouveautés de cette version ?
Cette version v0.14Beta contient les modifications suivantes :


Correction des commentaires sur de propriétée de classe non renseignés (Tracker 1398703)
Correction d'une exception du parser avec un cast en System.Object ou System.Type (Tracker 1398699)
Correction d'une exception du parser avec mot-clé dans un nom composé (Tracker 1411446)
Correction d'une exception lorsqu'une classe est déclarée dans l'implementation (Tracker 1413730)
Ajout du support du caractète '&' avant un identifiant ou une méthode (Tracker 1398699)
Ajout du support de l'écriture des tableaux dynamiques et tableaux ouverts (Tracker 1398699)
Correction de la confusion lors de l'utilisation des même identifiant dans un même espace de nommage (Tracker 1398703)
Correction d'une erreur lors de l'utilisation de System.Object or System.Type (Tracker 1398699)
Correction d'une exception du parser avec le mot-clé 'var' dans une classe (Tracker 1398699)
Ajout du support du multicast (Add et Remove) dans les propriétés (Tracker 1398699)
Ajout d'une option pour copier le commentaire de l'accesseur pour les propriétés non-commentées
Ajout d'un lien vers l'accesseur dans la documentation html pour les propriétés
Correction du lien 'Suivant' jamais actif dans la barre d'outils HTML
Ajout du support des unités avec un nom composé
Ajout du lien vers le parent pour les classes dans la documentation HTML
Correction du répertoire non sauvegardé lors de la selection d'un fichier ou d'un répertoire (Tracker 1251032)
Ajout du lien vers la classe pour les membres (Tracker 1206745)
Ajout du support des des directives de classe 'Sealed' et 'Final' (Tracker 1380515)
Ajout du support de la directive de méthode 'Final' (Tracker 1337618)
Correction d'une assertion lors de la deuxième construction de la documentation (Tracker 1234775)
Modification de la valeur par défaut de l'option 'HideEmptyOutputBlock' de Faux à Vrai
Correction des membres imbriqués manquant dans le fichier CHM
Correction de la visibilité pour les classes imbriquées
Correction d'une exception du parser avec le mot-clé Index pour une fonction externe (Tracker 369011)
Correction des parents pour les UseUnit, Class et Interface (Tracker 1348051)
Correction de la fonctionnalité 'cacher les blocks vides"
Ajout du support pour les constantes imbriquées dans une classe
Ajout du support pour les classes imbriquées dans une classe
Ajout du support pour les variables imbriquées dans une classe
Ajout du support des espaces de nom composés (Tracker 1331694)
Ajout du support des noms composés pour les identifiants (type, uses, inheritance ...)
Ajout de la visibilité 'Strict' dans la documentation
Mise à jour de la structure interne pour simplifier la gestion des classes et types imbriqués
Correction d'une exception avec une classe définie dans l'implementation (Tracker 1226175)
Correction d'une exception lors de l'utilisation d'un mot réservé comme identifiant (Tracker 1145132, 1298482)
Correction d'une exception lors de la destruction de la classe TDocOptions
Ajout d'une option 'Autoriser le HTML dans la description" pour embarquer du HTML
Correction de l'encodage HTML des caractères spéciaux (Tracker 1232749)
Correction du delimiteur de chemin du fichier CSS dans le HTML (Tracker 1305970)
Correction du crash du programme à la seconde analyse (Tracker 1234775)
Correction du crash du programme après une analyse échouée (Tracker 1230817)

Quels sont les bugs connus du logiciel ?
*Les traductions ne sont pas à jour

Quelles sont les limitations connues du programme ?
*Les variables de classe ne peuvent être commentées que par un commentaire inline juste après la declaration
*Les évenements n'ont pas de description
*Seul l'Anglais est disponible pour le document généré
*Le TAG @see n'est pas supporté

Quelles seront les futures évolutions ?
*

Xander, Je travaille en ce moment sur la version XML du fichier de config (binaire précédement).
Cela devrait solutionner tes soucis je pense ?

Les fichiers de configurations sont maintenant sauvegardés au format XML à partir de la version v0.14beta.1
Enfin

ANN: DelphiCodeToDoc v0.15Beta disponible - Outil gratuit de generation de documentation pour Delphi

La dernière version de DelphiCodeToDoc (v0.15Beta) est disponible. Elle peut être téléchargée ici :

http://prdownloads.sourceforge.net/d...b.zip?download


-----------------------------------------------------------------
Quelles sont les nouveautés de cette version ?
Cette version v0.15Beta contient les modifications suivantes :

Mise à jour du fichier de configuration en XML
Ajout d'une fonction d'import de l'ancien fichier de configuration (*.dcd)
Mise à jour du projet avec Delphi2006
Ajout du nom du projet dans le titre de la feuille
Ajout d'une confirmation lors de la fermeture d'un projet
Correction d'un problème lorsque l'assesseur n'est pas défini dans l'unité (Tracker 1482445)
Correction d'un problème avec les commentaires commençant par (** (Tracker 1352650)
Correction du répertoire de sortie impossible à modifier pour un projet existant (Tracker 1475301)
Correction lors de la sauvegarde et du chargement d'un projet
Suppression de l'affichage de la boite dos lors d'un appel à HHC.exe pour compiler le CHM (Tracker 1119969)
Ajout des messages produits pas hhc.exe dans la fenêtre de debug (Tracker 1462810)
Ajout d'un apnneau d'attente pour l'utilisateur (la compilation du CHM peut prendre du temps)
Mise à jour des informations de copyright
Correction des noms de fichiers COM (Tracker 1447905)
Correction d'une assertion lorsque qu'une proprieté est liée à une variable de classe (Tracker 1460512)
Correction du lien html dans la barre d'outils (Tracker 1469081)


Quels sont les bugs connus du logiciel ?
*Les traductions ne sont pas à jour

Quelles sont les limitations connues du programme ?
*Les variables de classe ne peuvent être commentées que par un commentaire inline juste après la declaration
*Les évenements n'ont pas de description
*Seul l'Anglais est disponible pour le document généré
*Le TAG @see n'est pas supporté

Quelles seront les futures évolutions ?
*

Merci
Tu as une date de prévue pour la V1.0 ?

Salut, je viens de voir un très bon référent pour ton outil.

Salut Laurent, désolé pour la réponse tardive, mais je n'ai aps reçu de mail pour m'avertir de ta réponse ...

La v1.0 sortira ... lorsque tous les bugs / fonctionnalitées critiques seront corrigés ... il y en a encore pas mal :

* Pb de traductions
* Pb avec les langues étendue (chinois, coréens, etc ...)
* Pb avec les records
* manque un graphe des classes, et un résumé de la couverture de commentaire.

Donc, pour le tout début 2007 avec en prime qcq nouveauté (nouveau générateur de doc en XML + XSLT en plus de HTML/CHM).

Salut, je viens de voir un très bon référent pour ton outil.

Oui, j'avais contacté à l'époque Zarko Gajic pour faire un peu de pub , et cela a très bien marché (x5 en nombre de visite et download sur 1 mois).