.. index:: single: psdoc psdoc ===== -------------- :: Version : 1.0 File Name : psdoc.ps1 Author : Adewale Azeez - iamthecarisma@gmail.com Date : March-12-2020 -------------- Add the -Verbose switch to see more output in the shell Syntax ------ .. code:: powershell psdoc [-Path] [-OutputFolder] [-Silent] [-Recurse] [] Parameters ---------- -Path :String ~~~~~~~~~~~~~ The path to the powershell scri[t to extract documentation =========================== ===== attr value =========================== ===== Required? true Position? 1 Default value Accept pipeline input? false Accept wildcard characters? false =========================== ===== -OutputFolder :String ~~~~~~~~~~~~~~~~~~~~~ the folder to put generated exported documenation =========================== ===== attr value =========================== ===== Required? true Position? 2 Default value Accept pipeline input? false Accept wildcard characters? false =========================== ===== -Silent [:SwitchParameter] ~~~~~~~~~~~~~~~~~~~~~~~~~~ whether to print anything to the console =========================== ===== attr value =========================== ===== Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false =========================== ===== -Recurse [:SwitchParameter] ~~~~~~~~~~~~~~~~~~~~~~~~~~~ generate psdoc in subfolders? =========================== ===== attr value =========================== ===== Required? false Position? named Default value False Accept pipeline input? false Accept wildcard characters? false =========================== ===== CommonParameters ~~~~~~~~~~~~~~~~ This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216). Inputs ------ None Outputs ------- System.String EXAMPLE 1 --------- :: psdoc .\ .\dist\cronux_doc\ -Recurse EXAMPLE 2 --------- :: Related links ------------- - https://thecarisma.github.io/Cronux