FPDoc Updater

From Lazarus-ccr

Jump to: navigation, search

[edit] Introduction

FPDoc Updater is a GUI tool for updating FPDoc files. You can find it in lazarus/doceditor/fpdocupdater/ directory.

[edit] Features

  • uses FPC Makeskel tool for generating FPDoc skeletons
  • mass update of FPDoc files for selected Pascal units
  • preserves written description in FPDoc elements
  • content of removed elements can be moved to different element
  • can backup processed FPDoc files
  • handles multiple elements with same name
  • can show update summary

[edit] Usage

Set correct paths for FPDoc files, Pascal units, include files and Makeskel tool. Select from the list which FPDoc files should be updated and push Update button.

Image:FPDocUpdater.png