FPDoc Editor/de

From Lazarus wiki
Jump to navigationJump to search

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.

Usage

Using LazDoc is very simple.

1. Open the LazDoc editor. You can find it under the menu View.

2. Set the search path for LazDoc in the Environment | Environment options dialog, under the LazDoc tabpage.

3. Open or select a file for which documentation exists.

4. Place and move the cursor. After placing the cursor on the source editor, you will notice that the caption of the LazDoc form changes. The caption shows the source element selected and the filename of the documentation file. By selecting the appropriate page in LazDoc you can edit a specific documentation tag. Of course it is also possible to use LazDoc only as a viewer.

Future plans

The todo list currently contains the following items, in no particular order:

  • Add a HTML viewer
  • Make it work on project files also
  • Make LazDoc create new elements in documentation
  • Propose to expand documentation tags with: "todo" and "notes"
  • Add all documentation tags to LazDoc
  • Add more source elements to be interpreted by LazDoc using exisiting code tools (now procedure/function/constructor/destructor)
  • Reduce overhead even further
  • Use IPC for communication

DONE

  • Make it work for fpc sources (rtl files already exist)
  • Add settings to environment menu