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