Simple documentation

Author: christiangnrd

README.md

@@ -14,3 +14,14 @@
 
 [codecov-img]: https://codecov.io/gh/JuliaGPU/GPUToolbox.jl/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/JuliaGPU/GPUToolbox.jl
+
+## Functionality
+
+This package currently exports the following:
+- `SimpleVersion`: a GPU-compatible version number
+- `@sv_str`: constructs a SimpleVersion from a string
+- `@checked`: Add to a function definition to generate an unchecked and a checked version.
+- `@debug_ccall`: like `ccall` but prints the ccall, its arguments, and its return value
+- `@gcsafe_ccall`: like `@ccall` but marking it safe for the GC to run.
+
+For more details, check out the docstrings using the Julia REPL.

src/ccalls.jl

@@ -45,7 +45,11 @@ macro checked(ex)
 end
 
 ## version of ccall that prints the ccall, its arguments and its return value
+"""
+    @debug_ccall ...
 
+A version of `ccall`` that prints the ccall, its arguments, and its return value.
+"""
 macro debug_ccall(ex)
     @assert Meta.isexpr(ex, :(::))
     call, ret = ex.args

src/simpleversion.jl

@@ -1,7 +1,11 @@
-## a GPU-compatible version number
-
 export SimpleVersion, @sv_str
 
+"""
+    SimpleVersion(major, [minor])
+    SimpleVersion(v::AbstractString)
+
+A GPU-compatible version number.
+"""
 struct SimpleVersion
     major::UInt32
     minor::UInt32
@@ -37,6 +41,11 @@ SimpleVersion(v::AbstractString) = parse(SimpleVersion, v)
     return false
 end
 
+"""
+    sv"str"
+
+Construct a `SimpleVersion` from `str`.
+"""
 macro sv_str(str)
     return SimpleVersion(str)
 end