Difference between revisions of "FPDoc Editor/fr"
Paulatreides (talk | contribs) |
Paulatreides (talk | contribs) (→Usage) |
||
| Line 7: | Line 7: | ||
LazDoc est intégré dans l'IDE de Lazarus. Il peut être trouvé sous le menu de Voir . | LazDoc est intégré dans l'IDE de Lazarus. Il peut être trouvé sous le menu de Voir . | ||
| − | == | + | == Utilisation == |
| − | + | L'utilisation de LazDoc est très simple . | |
| − | 1. | + | 1. Fixer le chemin de recherche de LazDoc dans la boite de dialogue Projet | Options du projet..., sous l'onglet LazDoc. |
| − | 2. | + | 2. Ouvrir ou sélectionner un fichier pour lequel la documentation existe. |
| − | 3. | + | 3. Ouvrir l'éditeur LazDoc.Vous pouvez le trouver sous le menu Voir. |
| − | 4. | + | 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 . |
== Future plans == | == Future plans == | ||
Revision as of 16:24, 24 June 2007
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 de 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 .
Future plans
The todo list currently contains the following items, in no particular order:
- Make LazDoc create new elements in documentation
- Make LazDoc create new documentation files
- Add documentation tags "topic" to LazDoc
- Add more source elements to be interpreted by LazDoc using exisiting codetools (now procedure/function/constructor/destructor are supported)
- Add LazDoc to IDE settings (showing and position in IDE)
- Use IPC for communication
- Make LazDoc work on keydown in sourceeditor (broken)
- Make LazDoc a WYSIWYG editor, comparable to a richtext editor.
- Add a HTML viewer; LazDoc will generate the documentation automatically
DONE
- Adding a small toolbar makes it possible to use the available makeup tags.
- Add documentation tags "seealso" to LazDoc
- Make it work for fpc sources (rtl files already exist)
- Add settings to environment menu
- Make it work on project files also
- Propose to expand documentation tags with: "todo" and "notes" (no need for that, as there are alternatives)
- 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
