Various fixes to documentation (#520)

Fix missing docstrings and broken references in docstrings.

Author: giordano

docs/src/advanced.md

@@ -10,6 +10,7 @@ MPI.free
 
 ```@docs
 MPI.Datatype
+MPI.to_type
 MPI.Types.extent
 MPI.Types.create_contiguous
 MPI.Types.create_vector
@@ -40,4 +41,3 @@ MPI.ErrorHandler
 MPI.get_errorhandler
 MPI.set_errorhandler!
 ```
-

docs/src/collective.md

@@ -31,6 +31,7 @@ MPI.Allgatherv!
 
 ```@docs
 MPI.Scatter!
+MPI.Scatter
 MPI.Scatterv!
 ```
 
@@ -40,7 +41,6 @@ MPI.Scatterv!
 MPI.Alltoall!
 MPI.Alltoall
 MPI.Alltoallv!
-MPI.Alltoallv
 ```
 
 ## Reduce/Scan

docs/src/onesided.md

@@ -4,6 +4,7 @@
 MPI.Win_create
 MPI.Win_create_dynamic
 MPI.Win_allocate_shared
+MPI.Win_shared_query
 MPI.Win_flush
 MPI.Win_lock
 MPI.Win_unlock

docs/src/pointtopoint.md

@@ -4,7 +4,9 @@
 
 ```@docs
 MPI.Request
+MPI.RequestSet
 MPI.Status
+MPI.StatusRef
 ```
 
 ### Accessors
@@ -37,14 +39,14 @@ MPI.Irecv!
 ### Completion
 
 ```@docs
-MPI.Test!
-MPI.Testall!
-MPI.Testany!
-MPI.Testsome!
-MPI.Wait!
-MPI.Waitall!
-MPI.Waitany!
-MPI.Waitsome!
+MPI.Test
+MPI.Testall
+MPI.Testany
+MPI.Testsome
+MPI.Wait
+MPI.Waitall
+MPI.Waitany
+MPI.Waitsome
 ```
 
 ### Probe/Cancel
@@ -53,4 +55,4 @@ MPI.Waitsome!
 MPI.Cancel!
 MPI.Iprobe
 MPI.Probe
-```
+```

src/collective.jl

@@ -315,7 +315,7 @@ if the length can be determined from `sendbuf`. On non-root processes it is igno
 can be `nothing`.
 
 # See also
-- [`Gatherv`](@ref) for the allocating operation
+- [`Gatherv!`](@ref) for the allocating operation
 - [`Gather!`](@ref)
 - [`Allgatherv!`](@ref) to send the result to all processes
 
@@ -432,7 +432,6 @@ If only one buffer `sendrecvbuf` is provided, then for each process, the data to
 is taken from the interval of `recvbuf` where it would store its own data.
 
 # See also
-- [`Allgatherv`](@ref) for the allocating operation
 - [`Gatherv!`](@ref) to send the result to a single process
 
 # External links

src/datatypes.jl

@@ -372,6 +372,13 @@ function create_resized!(newtype::Datatype, oldtype::Datatype, lb::Integer, exte
     return newtype
 end
 
+function duplicate!(newtype::Datatype, oldtype::Datatype)
+    # int MPI_Type_dup(MPI_Datatype oldtype, MPI_Datatype * newtype)
+    @mpichk ccall((:MPI_Type_dup, libmpi), Cint,
+                  (MPI_Datatype, Ptr{MPI_Datatype}),
+                  oldtype, newtype)
+    return newtype
+end
 """
     MPI.Types.duplicate(oldtype::Datatype)
 
@@ -380,13 +387,6 @@ Duplicates the datatype `oldtype`.
 # External links
 $(_doc_external("MPI_Type_dup"))
 """
-function duplicate!(newtype::Datatype, oldtype::Datatype)
-    # int MPI_Type_dup(MPI_Datatype oldtype, MPI_Datatype * newtype)
-    @mpichk ccall((:MPI_Type_dup, libmpi), Cint,
-                  (MPI_Datatype, Ptr{MPI_Datatype}),
-                  oldtype, newtype)
-    return newtype
-end
 duplicate(oldtype::Datatype) = duplicate!(Datatype(), oldtype::Datatype)
 
 """

src/environment.jl

@@ -134,7 +134,7 @@ An Enum denoting the level of threading support in the current process:
 
 # See also
 
-- [`Init_thread`](@ref)
+- [`Init`](@ref)
 - [`Query_thread`](@ref)
 """
 @enum ThreadLevel begin
@@ -200,12 +200,12 @@ end
 """
     Finalize()
 
-Marks MPI state for cleanup. This should be called after [`MPI.Init`](@ref) or
-[`MPI.Init_thread`](@ref), and can be called at most once. No further MPI calls (other
-than [`Initialized`](@ref) or [`Finalized`](@ref)) should be made after it is called.
+Marks MPI state for cleanup. This should be called after [`MPI.Init`](@ref), and
+can be called at most once. No further MPI calls (other than
+[`Initialized`](@ref) or [`Finalized`](@ref)) should be made after it is called.
 
-[`MPI.Init`](@ref) and [`MPI.Init_thread`](@ref) will automatically insert a hook to
-call this function when Julia exits, if it hasn't already been called.
+[`MPI.Init`](@ref) will automatically insert a hook to call this function when
+Julia exits, if it hasn't already been called.
 
 # External links
 $(_doc_external("MPI_Finalize"))

src/nonblocking.jl

@@ -528,4 +528,3 @@ function Cancel!(req::Request)
     @mpichk ccall((:MPI_Cancel, libmpi), Cint, (Ptr{MPI_Request},), req)
     nothing
 end
-