Difference between revisions of "FPDoc Updater"

From Free Pascal wiki
Jump to navigationJump to search
Line 8: Line 8:
 
* content of removed elements can be moved to different element or FPDoc file
 
* content of removed elements can be moved to different element or FPDoc file
 
* can backup processed FPDoc files
 
* can backup processed FPDoc files
 +
 +
== TODO ==
 +
* preserve topics
 +
* handle multiple elements with same name
  
 
== Usage ==
 
== Usage ==

Revision as of 11:33, 4 October 2007

Introduction

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

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 or FPDoc file
  • can backup processed FPDoc files

TODO

  • preserve topics
  • handle multiple elements with same name

Usage

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

FPDocUpdater.png