Difference between revisions of "FPDoc Editor/de"

From Lazarus wiki
Jump to navigationJump to search
Line 32: Line 32:
 
* IPC für die Kommunikation benutzen
 
* IPC für die Kommunikation benutzen
  
== DONE ==
+
== Erledigt ==
* Make it work for fpc sources (rtl files already exist)
+
* Arbeiten für FPC Quellen zu schaffen (rtl Dateien existieren bereits)
* Add settings to environment menu
+
* Einstellungen zum Umgebungseinstellungen Menü hinzufügen

Revision as of 19:19, 16 September 2005

Einleitung

LazDoc ist ein integrierter Editor/Betrachter für Lazarus. Hierzu beschriebene Elemente und der Gebrauch von LazDoc selbst efordern von ihnen, mit FPDoc vertraut zu sein. Für mehr Informationen siehe: Free Pascal Dokumentationstool Handbuch

Wo ist LazDoc zu finden??

Weil LazDoc sich noch in der Entwicklung befindet, und es nicht klar ist, ob es ein Teil von Lazarus selbst werden wird oder ein separates Package / Bibliothek, ist LazDoc nur verfügbar, wenn Lazarus kompiliert wird mit der -dEnableLazDoc Einstellung.

 make OPT="-dEnableLazDoc" clean all

Wenn sie Lazarus aus Lazarus heraus kompiliert haben, vergessen sie nicht, die Option im "Build Lazarus" Dialog zu setzen.

Gebrauch

Die Verwendung von LazDoc ist sehr einfach.

1. Öffnen sie den LazDoc Editor. Sie können ihn im Ansicht Menü finden.

2. Setzen sie den Suchpfad für LazDoc in dem Einstellungen | Umgebungseinstellungen Dialog, unter der LazDoc Registerseite.

3. Öffnen oder wählen sie eine Datei, für die eine Dokumentation existiert.

4. Setzen und bewegen sie den Cursor. Nachdem der Cursor im Quelltext Editor platziert wurde, werden sie beobachten, daß sich die Beschriftung des LazDoc Formulars ändert. Die Beschriftung zeigt das ausgewählte Quellelement und den Dateinamen der Dokumentations Datei. Durch Auswahl der geeigneten Seite in LazDoc können sie ein spezifisches Dokumentations Tag bearbeiten. Natürlich ist es auch möglich, LazDoc nur als Betrachter zu nutzen.

Zukünftige Pläne

Die todo Liste enthält gegenwärtig die folgenden Punkte, in keiner besonderen Reihenfolge:

  • Einen HTML Viewer hinzufügen
  • Auch das Bearbeiten von Projektdateien ermöglichen
  • Das Erstellen neuer Elemente mit LazDoc in der Dokumentation ermöglichen
  • Vorschlag die Dokumentations Tags zu erweitern mit: "todo" und "notes"
  • Alle Dokumentations Tags zu LazDoc hinzufügen
  • Mehr Quellen Elemente für die Interpretation durch LazDoc hinzufügen unter Verwendung existierender Code Werkzeuge (jetzt procedure/function/constructor/destructor)
  • Den Overhead noch weiter zu reduzieren
  • IPC für die Kommunikation benutzen

Erledigt

  • Arbeiten für FPC Quellen zu schaffen (rtl Dateien existieren bereits)
  • Einstellungen zum Umgebungseinstellungen Menü hinzufügen