Stow.pm: reformat old comment style as pod

As previously noted, the old comment style was difficult to edit.
It's also not idiomatic Perl style, so reformat as pod.  This exposes
more of the inner workings of Stow as documentation, but that
shouldn't be a problem.

As part of this change, remove outdated and sometimes misleading
information about if/when each function throws an exception.
This commit is contained in:
Adam Spiers 2024-03-31 16:10:08 +01:00
parent f4f3836c5f
commit 245dc83849
2 changed files with 667 additions and 369 deletions

5
NEWS
View file

@ -22,13 +22,14 @@ News file for Stow.
***** Added some more information from the web page to the README ***** Added some more information from the web page to the README
***** Made some small improvements to the documentation ***** Made some improvements to the documentation
***** Improve readability of source code ***** Improve readability of source code
Quite a few extra details have been added in comments to clarify Quite a few extra details have been added in comments to clarify
how the code works. Some variable names have also been how the code works. Some variable names have also been
improved. improved. The comments of many Stow class methods have been
converted into Perl POD format.
***** Added a =CONTRIBUTING.md= file ***** Added a =CONTRIBUTING.md= file

File diff suppressed because it is too large Load diff