]> git.proxmox.com Git - pve-common.git/commit
projects / pve-common.git / commit
? search:
summary | shortlog | log | commit | commitdiff | tree
(parent: 6dc7a73) | patch
section config: document package and its methods with POD
authorMax Carrara <m.carrara@proxmox.com>
Tue, 4 Jun 2024 09:28:48 +0000 (11:28 +0200)
committerFabian Grünbichler <f.gruenbichler@proxmox.com>
Thu, 4 Jul 2024 08:54:48 +0000 (10:54 +0200)
commitd41bd420f8b5421cf95d9403728ba28b17a420e5
treebe8eb04b9402ae6003811bae0f1a41c3196c969atree
parent6dc7a73bd50efc72e8260dcda2cf2ec4f158401dcommit | diff
section config: document package and its methods with POD

Apart from the obvious benefits that documentation has, this also
allows LSPs to provide docstrings e.g. via 'textDocument/hover' [0].

Tested with Perl Navigator [1].

[0]: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_hover
[1]: https://github.com/bscan/PerlNavigator

Signed-off-by: Max Carrara <m.carrara@proxmox.com>
src/PVE/SectionConfig.pm diff | blob | blame | history
Common code