add docs page for point-to-point (#318)

JuliaParallel · Nov 18, 2019 · ca95656 · ca95656
1 parent 0a643dc
commit ca95656
Show file tree

Hide file tree

Showing 6 changed files with 266 additions and 182 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -48,6 +48,7 @@ makedocs(
         "Reference" => [
             "environment.md",
             "comm.md",
+            "pointtopoint.md",
             ],
         "functions.md",
         ]

diff --git a/docs/src/comm.md b/docs/src/comm.md
@@ -6,6 +6,12 @@ each process a unique *rank* (see [`MPI.Comm_rank`](@ref)) taking an integer val
 `0:n-1`, where `n` is the number of processes in the communicator (see
 [`MPI.Comm_size`](@ref).
 
+## Types
+
+```@docs
+MPI.Comm
+```
+
 ## Constants
 
 ```@docs
@@ -15,14 +21,26 @@ MPI.COMM_SELF
 
 ## Functions
 
+### Accessors
+
+```@docs
+MPI.Comm_size
+MPI.Comm_rank
+```
+
+### Constructors
+
 ```@docs
 MPI.Comm_dup
 MPI.Comm_get_parent
-MPI.Comm_rank
-MPI.Comm_size
 MPI.Comm_spawn
 MPI.Comm_split
 MPI.Comm_split_type
 MPI.Intercomm_merge
+```
+
+### Miscellaneous
+
+```
 MPI.universe_size
 ```
diff --git a/docs/src/functions.md b/docs/src/functions.md
@@ -24,45 +24,6 @@ MPI.Get_address
 MPI.mpitype
 ```
 
-## Point-to-point communication
-
-Julia Function (assuming `import MPI`) | Fortran Function
----------------------------------------|--------------------------------------------------------
- [`MPI.Cancel!`](@ref)                 | [`MPI_Cancel`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Cancel.3.php)
- [`MPI.Get_count`](@ref)               | [`MPI_Get_count`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Get_count.3.php)
- [`MPI.Iprobe`](@ref)                  | [`MPI_Iprobe`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Iprobe.3.php)
- [`MPI.Irecv!`](@ref)                  | [`MPI_Irecv`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Irecv.3.php)
- [`MPI.Isend`](@ref)                   | [`MPI_Isend`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Isend.3.php)
- [`MPI.Probe`](@ref)                   | [`MPI_Probe`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Probe.3.php)
- [`MPI.Recv!`](@ref)                   | [`MPI_Recv`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Recv.3.php)
- [`MPI.Send`](@ref)                    | [`MPI_Send`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Send.3.php)
- [`MPI.Test!`](@ref)                   | [`MPI_Test`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Test.3.php)
- [`MPI.Testall!`](@ref)                | [`MPI_Testall`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Testall.3.php)
- [`MPI.Testany!`](@ref)                | [`MPI_Testany`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Testany.3.php)
- [`MPI.Testsome!`](@ref)               | [`MPI_Testsome`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Testsome.3.php)
- [`MPI.Wait!`](@ref)                   | [`MPI_Wait`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Wait.3.php)
- [`MPI.Waitall!`](@ref)                | [`MPI_Waitall`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Waitall.3.php)
- [`MPI.Waitany!`](@ref)                | [`MPI_Waitany`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Waitany.3.php)
- [`MPI.Waitsome!`](@ref)               | [`MPI_Waitsome`](https://www.open-mpi.org/doc/v1.10/man3/MPI_Waitsome.3.php)
-
-```@docs
-MPI.Cancel!
-MPI.Get_count
-MPI.Iprobe
-MPI.Irecv!
-MPI.Isend
-MPI.Probe
-MPI.Recv!
-MPI.Send
-MPI.Test!
-MPI.Testall!
-MPI.Testany!
-MPI.Testsome!
-MPI.Wait!
-MPI.Waitall!
-MPI.Waitany!
-MPI.Waitsome!
-```
 
 ## Collective communication
 

diff --git a/docs/src/pointtopoint.md b/docs/src/pointtopoint.md
@@ -0,0 +1,49 @@
+# Point-to-point communication
+
+## Types
+
+```@docs
+MPI.Request
+MPI.Status
+```
+
+## Functions
+
+### Accessor
+
+```@docs
+MPI.Get_count
+```
+
+### Blocking
+
+```@docs
+MPI.Send
+MPI.Recv!
+MPI.Sendrecv
+```
+
+### Non-blocking
+
+```@docs
+MPI.Isend
+MPI.Irecv!
+MPI.Test!
+MPI.Testall!
+MPI.Testany!
+MPI.Testsome!
+MPI.Wait!
+MPI.Waitall!
+MPI.Waitany!
+MPI.Waitsome!
+```
+
+### Probe and cancel
+
+```@docs
+MPI.Iprobe
+MPI.Probe
+MPI.Cancel!
+```
+
+
diff --git a/src/comm.jl b/src/comm.jl
@@ -1,3 +1,8 @@
+"""
+    MPI.Comm
+
+An MPI Communicator object.
+"""
 @mpi_handle Comm
 
 const COMM_NULL = _Comm(MPI_COMM_NULL)