FPDoc Editor

From Lazarus wiki
Revision as of 23:27, 14 September 2005 by Dblaszijk (talk | contribs) (→‎Usage)
Jump to navigationJump to search

Introduction

LazDoc is an integrated editor/viewer for Lazarus. It currently works only for the LCL, but expaning it to any project is top priority on the todo list. This page exects you are familiar with FPDoc, see for more information: Free Pascal documentation tool manual

Where to find LazDoc??

Because LazDoc is still in development, and it's not clear wether it will become part of Lazarus itself or it will be available as a separate package / library, LazDoc is only available when Lazarus is compiled with -dEnableLazDoc set.

 make OPT="-dEnableLazDoc" clean all

If you are used to compile Lazarus from Lazarus, don't forget to set the option in the Build Lazarus dialog.

Usage

Using LazDoc is very simple.

open the LazDoc editor

You can find it under the menu Tools.

  • open a file from LCL

open or select a file for which documentation exists. Currently it's still only LCL.

  • 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 apropriate page in LazDoc you can edit a specific documentation tag. It's ofcource also possible to use LazDoc only as a viewer.