Difference between revisions of "FPDoc Editor"

From Lazarus wiki
Jump to navigationJump to search
Line 8: Line 8:
 
   make OPT="-dEnableLazDoc" clean all
 
   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.
+
If you are used to compile Lazarus from Lazarus, don't forget to set the option in the "Build Lazarus" dialog.
  
 
== Usage ==
 
== Usage ==

Revision as of 23:59, 14 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 top priority on the todo list. This page/ using LazDoc expects 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.

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

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

3. 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.


Future plans

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

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