Difference between revisions of "FPDoc Editor"

From Lazarus wiki
Jump to navigationJump to search
Line 11: Line 11:
  
 
== Usage ==
 
== Usage ==
Using LazDoc is very simple. J
+
Using LazDoc is very simple. First open the LazDoc editor. You can find it under the menu Tools.
 +
After opening LazDoc, you can open or select a file for which documentation exists. Currently it's still only LCL.
 +
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.

Revision as of 00:18, 15 September 2005

Introduction

LazDoc is an integrated editor/viewer for Lazarus. It currently works only for the LCL, but expaning it to any project is on the todo list.


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. First open the LazDoc editor. You can find it under the menu Tools. After opening LazDoc, you can open or select a file for which documentation exists. Currently it's still only LCL. 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.