Skip to content

Commit c0897c4

Browse files
authored
Merge pull request #471 from Icinga:fix/plugin_doc_generator_newline_table
Fix: New-lines in plugin doc table generator
2 parents 36e6462 + da3eda5 commit c0897c4

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

lib/core/framework/Publish-IcingaPluginDocumentation.psm1

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,17 @@ function Publish-IcingaPluginDocumentation()
5353

5454
$AvailablePlugins = Get-ChildItem -Path $PluginDir -Recurse -Filter *.psm1;
5555
foreach ($plugin in $AvailablePlugins) {
56-
[string]$PluginName = $plugin.Name.Replace('.psm1', '');
57-
[string]$PluginDocName = '';
58-
$PluginDetails = Get-Help -Name $PluginName -Full;
56+
[string]$PluginName = $plugin.Name.Replace('.psm1', '');
57+
[string]$PluginDocName = '';
58+
[string]$PluginSynopsis = '-';
59+
$PluginDetails = Get-Help -Name $PluginName -Full;
60+
61+
if ($null -ne $PluginDetails -And [string]::IsNullOrEmpty($PluginDetails.Synopsis) -eq $FALSE) {
62+
$PluginSynopsis = $PluginDetails.Synopsis.Replace("`r`n", ' ');
63+
$PluginSynopsis = $PluginSynopsis.Replace("`r", ' ');
64+
$PluginSynopsis = $PluginSynopsis.Replace("`n", ' ');
65+
}
66+
5967
foreach ($DocFile in $MDFiles) {
6068
$DocFileName = $DocFile.Name;
6169
if ($DocFileName -Like "*$PluginName.md") {
@@ -80,7 +88,7 @@ function Publish-IcingaPluginDocumentation()
8088
'| [{0}](plugins/{1}) | {2} |',
8189
$PluginName,
8290
$PluginDocName,
83-
$PluginDetails.Synopsis
91+
$PluginSynopsis
8492
));
8593

8694
$PluginHelp = Get-Help $PluginName -Full;

0 commit comments

Comments
 (0)