(#2) Add type documentations for network models

Author: jbytecode

docs/src/network.md

@@ -6,18 +6,50 @@
 OperationsResearchModels.Connection
 ```
 
+## ShortestPathProblem
+
+```@docs
+OperationsResearchModels.ShortestPathProblem
+```
+
 ## Shortest Path
 
 ```@docs
 OperationsResearchModels.solve(t::ShortestPathProblem)
 ```
 
+## ShortestPathResult
+
+```@docs
+OperationsResearchModels.ShortestPathResult
+```
+
+## Maximum Flow Problem
+
+```@docs
+OperationsResearchModels.MaximumFlowProblem
+```
+
+
 ## Maximum Flow
 
 ```@docs
 OperationsResearchModels.solve(t::MaximumFlowProblem)
 ```
 
+## MaximumFlowResult
+
+```@docs
+OperationsResearchModels.MaximumFlowResult
+```
+
+## MinimumCostFlowProblem 
+
+```@docs
+OperationsResearchModels.MinimumCostFlowProblem
+```
+
+
 ## Minimum Cost Flow 
 
 ```@docs
@@ -29,8 +61,28 @@ OperationsResearchModels.solve(t::MinimumCostFlowProblem)
 OperationsResearchModels.solve(t::MinimumCostFlowProblem, flow::Float64)
 ```
 
+
+## MinimumCostFlowResult
+
+```@docs
+OperationsResearchModels.MinimumCostFlowResult
+```
+
+
+## MstProblem 
+
+```@docs
+OperationsResearchModels.MstProblem
+```
+
 ## Minimum Spanning Tree
 
 ```@docs
 OperationsResearchModels.solve(p::MstProblem)
 ```
+
+## MstResult
+
+```@docs
+OperationsResearchModels.MstResult
+```

src/maximumflow.jl

@@ -10,17 +10,44 @@ export MaximumFlowProblem, MaximumFlowResult
 
 
 
-struct MaximumFlowResult
-    path::Vector{Connection}
-    flow::Float64
-end
+"""
+    MaximumFlowProblem
+
+# Description
 
+Defines the maximum flow problem.
+
+# Fields
+
+- `connections::Vector{Connection}`: The connections (edges) in the network.
+
+"""
 struct MaximumFlowProblem
     connections::Vector{Connection}
 end
 
 
 
+"""
+    MaximumFlowResult
+
+# Description
+
+A structure to hold the result of the maximum flow problem.
+
+# Fields
+
+- `path::Vector{Connection}`: The connections (edges) in the flow path.
+- `flow::Float64`: The total flow through the network.
+
+"""
+struct MaximumFlowResult
+    path::Vector{Connection}
+    flow::Float64
+end
+
+
+
 
 
 

src/minimumcostflow.jl

@@ -8,11 +8,41 @@ import ..MaximumFlow: MaximumFlowProblem, MaximumFlowResult
 
 export MinimumCostFlowProblem, MinimumCostFlowResult
 
+
+
+"""
+    MinimumCostFlowProblem
+
+# Description
+
+Defines the minimum cost flow problem.
+
+# Fields
+
+- `connections::Vector{Connection}`: The connections (edges) in the network.
+- `costs::Vector{Connection}`: The costs associated with each connection.
+
+"""
 struct MinimumCostFlowProblem
     connections::Vector{Connection}
     costs::Vector{Connection}
 end
 
+
+
+"""
+    MinimumCostFlowResult
+
+# Description
+
+A structure to hold the result of the minimum cost flow problem.
+
+# Fields
+
+- `path::Vector{Connection}`: The connections (edges) in the flow path.
+- `cost::Float64`: The total cost of the flow.
+
+"""
 struct MinimumCostFlowResult 
     path::Vector{Connection}
     cost::Float64

src/mst.jl

@@ -9,16 +9,42 @@ export mst
 export MstResult
 export MstProblem
 
-struct MstResult
+
+"""
+    MstProblem 
+
+# Description
+    Defines the minimum spanning tree problem.
+
+# Fields
+- `connections::Vector{Connection}`: The connections (edges) in the network. 
+
+# Note 
+    The Connection object defined a directed edge, but for the minimum spanning tree problem, the edges are considered undirected.
+"""
+struct MstProblem
     connections::Vector{Connection}
-    distance::Float64
 end
 
-struct MstProblem
+
+"""
+    MstResult
+
+# Description
+    A structure to hold the result of the minimum spanning tree problem.
+
+# Fields
+- `connections::Vector{Connection}`: The connections (edges) in the minimum spanning tree.
+- `distance::Float64`: The total distance (weight) of the minimum spanning tree.
+
+"""
+struct MstResult
     connections::Vector{Connection}
+    distance::Float64
 end
 
 
+
 function hasloop(conns::Vector{Connection})::Bool
     if length(conns) <= 1
         return false

src/shortestpath.jl

@@ -11,10 +11,36 @@ export ShortestPathProblem
 export ShortestPathResult
 
 
+"""
+    ShortestPathProblem
+
+# Description
+
+Defines the shortest path problem.
+
+# Fields
+
+- `connections::Vector{Connection}`: The connections (edges) in the network.
+
+"""
 struct ShortestPathProblem 
     connections::Vector{Connection}
 end 
 
+
+"""
+    ShortestPathResult
+
+# Description
+
+A structure to hold the result of the shortest path problem.
+
+# Fields
+
+- `path::Vector{Connection}`: The connections (edges) in the shortest path.
+- `cost::Float64`: The total cost of the shortest path.
+
+"""
 struct ShortestPathResult
     path::Vector{Connection}
     cost::Float64