FPDoc Updater: what changed
Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.
Title: FPDoc Updater
| Old | New | Line | |
|---|---|---|---|
| 1 | + | ## Introduction | |
| 2 | + | ||
| 3 | + | FPDoc Updater is a GUI tool for updating FPDoc files. You can find it in lazarus/doceditor/fpdocupdater/ directory. | |
| 4 | + | ||
| 5 | + | ## Features | |
| 6 | + | ||
| 7 | + | - uses FPC Makeskel tool for generating FPDoc skeletons | |
| 8 | + | - mass update of FPDoc files for selected Pascal units | |
| 9 | + | - preserves written description in FPDoc elements | |
| 10 | + | - content of removed elements can be moved to different element | |
| 11 | + | - can backup processed FPDoc files | |
| 12 | + | - handles multiple elements with same name | |
| 13 | + | - can show update summary | |
| 14 | + | ||
| 15 | + | ## Usage | |
| 16 | + | ||
| 17 | + | Set correct paths for FPDoc files, Pascal units, include files and Makeskel tool. | |
| 18 | + | ||
| 19 | + | **Hint:** The Makeskel tool is in you FPC/bin directory. | |
| 20 | + | ||
| 21 | + | **Hint:** Terminate the application after setting up the paths, to save your changes. The tool tends to crash :-( | |
| 22 | + | ||
| 23 | + | <figure> | |
| 24 | + | <img src="FPDocUpdater.png" title="FPDocUpdater.png" /> | |
| 25 | + | <figcaption>FPDocUpdater.png</figcaption> | |
| 26 | + | </figure> | |
| 27 | + | ||
| 28 | + | **Beware:** Uncheck "Show summary" before creating skeletons from multiple files, or you have to click away the summary dialog for every processed file. | |
| 29 | + | ||
| 30 | + | Select from the list which FPDoc files should be updated and push Update button, or | |
| 31 | + | ||
| 32 | + | **Refresh** refreshes the file list(?) | |
| 33 | + | ||
| 34 | + | **Update** updates the selected file(s) | |
| 35 | + | ||
| 36 | + | **Update New** updates all new files (marked red) | |
| 37 | + | ||
| 38 | + | **Update All** updates all files. | |
| 39 | + | ||
| 40 | + | ### Usage with other tools | |
| 41 | + | ||
| 42 | + | The Updater does not interface well with LazDe. | |
| 43 | + | ||
| 44 | + | ToDo: Add feature or instructions for creating packages for processing with the [[Lazarus Documentation Editor]]. | |
| 45 | + | ||
| 46 | + | --- | |
| 47 | + | *From the Free Pascal wiki, page "FPDoc Updater", as it stood on 2014-09-28 after a change by BigChimp, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 48 | + | Category: Help and Docs |