Merge pull request #17 from hyrodium/feature/doc

Update docs, bump version to 0.0.2

Project.toml

@@ -1,7 +1,7 @@
 name = "ImageClipboard"
 uuid = "6db54171-f50f-4661-a74f-bc514ef16cee"
 authors = ["hyrodium <[email protected]> and contributors"]
-version = "0.0.1"
+version = "0.0.2"
 
 [deps]
 ColorTypes = "3da002f7-5984-5a60-b8a6-cbb66c0b333f"

docs/src/functionreference.md

@@ -1,9 +1,23 @@
+```@meta
+CurrentModule = ImageClipboard
+```
+
 # Function reference
 
 ## Index
 ```@index
 ```
 
+## Public methods
+
+```@docs
+clipboard_img()
+```
+
+```@docs
+clipboard_img(::Matrix{<:Colorant})
+```
+
 ## Private methods
 ```@autodocs
 Modules = [ImageClipboard]

docs/src/index.md

@@ -29,16 +29,6 @@ img2 = clipboard_img()
 img == img2
 ```
 
-## Public methods
-
-```@docs
-clipboard_img()
-```
-
-```@docs
-clipboard_img(::Matrix{<:Colorant})
-```
-
 ## Sample screenshots
 ### Copy an image
 ![](img/screenshot_copy.gif)

src/_powershell.jl

@@ -1,4 +1,6 @@
 """
+    clipboard_img() -> Matrix{<:Colorant}
+
 Paste an image from clipboard using powershell
 """
 function _powershell()
@@ -25,6 +27,8 @@ end
 
 
 """
+    clipboard_img(img::Matrix{<:Colorant})
+
 Copy an image to clipboard using powershell
 """
 function _powershell(img::Matrix{<:Colorant})

src/_wlclipboard.jl

@@ -3,6 +3,8 @@ function _isavailable_wlclipboard()
 end
 
 """
+    clipboard_img() -> Matrix{<:Colorant}
+
 Paste an image from clipboard using wl-paste
 """
 function _wlclipboard()
@@ -19,6 +21,8 @@ function _wlclipboard()
 end
 
 """
+    clipboard_img(img::Matrix{<:Colorant})
+
 Copy an image to clipboard using wl-copy
 """
 function _wlclipboard(img::Matrix{<:Colorant})

src/_xclip.jl

@@ -3,6 +3,8 @@ function _isavailable_xclip()
 end
 
 """
+    clipboard_img() -> Matrix{<:Colorant}
+
 Paste an image from clipboard using xclip
 """
 function _xclip()
@@ -19,6 +21,8 @@ function _xclip()
 end
 
 """
+    clipboard_img(img::Matrix{<:Colorant})
+
 Copy an image to clipboard using xclip
 """
 function _xclip(img::Matrix{<:Colorant})