Add doc strings to Copy-FilePath

StefanGreve · Dec 28, 2024 · 3d18767 · 3d18767
1 parent 879e7db
commit 3d18767
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/src/Public/Copy-FilePath.ps1 b/src/Public/Copy-FilePath.ps1
@@ -1,4 +1,26 @@
 function Copy-FilePath {
+    <#
+        .SYNOPSIS
+        Copies the full path of a file to clipboard.
+
+        .DESCRIPTION
+        Copies the full path of a file to clipboard.
+        Takes any string for file paths that exists.
+
+        .PARAMETER Path
+        Specifies the file path.
+
+        .INPUTS
+        None. You can't pipe objects to Copy-FilePath.
+
+        .EXAMPLE
+        PS> Copy-FilePath ./src/README.md
+
+        Copies the full path of the README.md file to clipboard.
+
+        .OUTPUTS
+        None. This function does not produce any output
+    #>
     [OutputType([void])]
     param (
         [Parameter(Position = 0, Mandatory)]