Merge pull request #42 from Saransh-cpp/fix-missing-docs-and-references

Fix missing docs and cross-references

Author: ToucheSir

.gitignore

@@ -1,3 +1,5 @@
 .DS_Store
 /dev/
 Manifest.toml
+build
+.vscode

docs/make.jl

@@ -3,10 +3,11 @@ using Documenter, Functors
 DocMeta.setdocmeta!(Functors, :DocTestSetup, :(using Functors); recursive = true)
 
 makedocs(modules = [Functors],
-         doctest = VERSION == v"1.6",
+         doctest = false,
          sitename = "Functors.jl",
          pages = ["Home" => "index.md",
                   "API" => "api.md"],
+         strict = [:cross_references, :missing_docs],
          format = Documenter.HTML(
              analytics = "UA-36890222-9",
              assets = ["assets/flux.css"],

src/Functors.jl

@@ -19,20 +19,20 @@ Returns a tuple containing, first, a `NamedTuple` of the children of `x`
 This controls the behaviour of [`fmap`](@ref).
 
 Methods should be added to `functor(::Type{T}, x)` for custom types,
-usually using the macro [@functor](@ref).
+usually using the macro [`@functor`](@ref).
 """
 functor
 
 @static if VERSION >= v"1.5"  # var"@functor" doesn't work on 1.0, temporarily disable
-"""
+@doc """
     @functor T
     @functor T (x,)
 
 Adds methods to [`functor`](@ref) allowing recursion into objects of type `T`,
 and reconstruction. Assumes that `T` has a constructor accepting all of its fields,
 which is true unless you have provided an inner constructor which does not.
 
-By default all fields of `T` are considered [children](@ref); 
+By default all fields of `T` are considered [`children`](@ref); 
 this can be restricted be restructed by providing a tuple of field names.
 
 # Examples