Difference between revisions of "FPDoc Updater"
From Free Pascal wiki
Jump to navigationJump to search| Line 6: | Line 6: | ||
* mass update of FPDoc files for selected Pascal units | * mass update of FPDoc files for selected Pascal units | ||
* preserves written description in FPDoc elements | * preserves written description in FPDoc elements | ||
| − | * content of removed elements can be moved to different element | + | * content of removed elements can be moved to different element |
* can backup processed FPDoc files | * can backup processed FPDoc files | ||
| − | + | * handles multiple elements with same name | |
| − | + | * can show update summary | |
| − | |||
| − | * | ||
== Usage == | == Usage == | ||
| − | Set correct paths for FPDoc files, Pascal units, include files and Makeskel tool. Select | + | 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]] | [[Image:FPDocUpdater.png]] | ||
Revision as of 16:34, 12 November 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
- can backup processed FPDoc files
- handles multiple elements with same name
- can show update summary
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.
