FPDoc Editor/fr

From Free Pascal wiki
Jump to: navigation, search

Deutsch (de) English (en) français (fr) 日本語 (ja) português (pt) русский (ru)

Introduction

LazDoc est un éditeur/visionneur intégré pour Lazarus. Les articles décrits ici et utilisant LazDoc lui-même exige de vous d'être au courant de FPDoc. Pour plus d'information voir : manuel de documentation d'outil de Free Pascal

Où trouver LazDoc ?

LazDoc est intégré dans l'IDE de Lazarus. Il peut être trouvé sous le menu Voir .

Utilisation

L'utilisation de LazDoc est très simple .

1. Fixer le chemin de recherche de LazDoc dans la boite de dialogue Projet | Options du projet..., sous l'onglet LazDoc.

2. Ouvrir ou sélectionner un fichier pour lequel la documentation existe.

3. Ouvrir l'éditeur LazDoc.Vous pouvez le trouver sous le menu Voir.

4. Placer et déplacer le curseur . Après avoir placé le curseur sur l'éditeur de source, vous noterez que la légende de la fiche de LazDoc change. La légende montre l'élément de source choisi et le nom de fichier du fichier de documentation . En choisissant la page appropriée dans LazDoc vous pouvez éditer une étiquette spécifique de documentation . Naturellement il est également possible d'employer LazDoc seulement comme un visionneur .

Futurs plans

La liste de choses à faire contient actuellement les articles suivants, dans aucun ordre particulier :

  • Faire que LazDoc créer de nouveaux éléments dans la documentation
  • Faire que LazDoc créer de nouveaux fichiers de documentation
  • Ajouter les étiquettes de documentation « topic » à LazDoc
  • Ajouter plus d'éléments de source à être interprété par LazDoc en employant les codetools existants (maintenant procedure/function/constructor/destructor sont supportés )
  • Ajouter LazDoc aux paramètres de l'ide (showing and position in IDE)
  • Employer l'IPC pour la communication
  • Faire que LazDoc fonctionne on keydown in sourceeditor (broken)
  • Faire que LazDoc soit un éditeur WYSIWYG, comparable à un éditeur editor richtext.
  • Ajouter un visualisateur HTML; LazDoc produira la documentation automatiquement

FAIT

  • Ajouter une petite barre d'outils rendant possible l'emploi des étiquettes disponibles de makeup .
  • Ajouter les étiquettes de documentation "seealso" à LazDoc
  • Faire qu'il fonctionne avec les sources fpc (les fichiers rtl existent déjà )
  • Ajouter des paramètres au menu configuration
  • Faire qu'il fonctionne aussi sur les fichier projet
  • Proposer de developper les étiquettes de documentation avec : "todo" et "notes" (aucun besoin de cela ,car il y a des solutions de rechange )
  • Reduce overhead even further
  • Find inherited entries. For example TControl.Align of TButton.Align.
  • Optimization: inherited Entries are parsed on idle.
  • Optimization: xml files are cached, and only parsed once or if they changed on disk