update documentation

Author: jbytecode

src/OperationsResearchModels.jl

@@ -2,6 +2,13 @@ module OperationsResearchModels
 
 using JuMP, HiGHS
 
+# This function has several methods to solve different types of problems including: 
+# solve(t::TransportationProblem)::TransportationResult
+# solve(s::ShortestPathProblem)::ShortestPathResult
+# solve(m::MaximumFlowProblem)::MaximumFlowResult
+# solve(a::AssignmentProblem)::AssignmentResult
+# solve(g::Game)::GameResult
+# solve(m::MstProblem)::MstResult
 solve() = nothing 
 
 export solve 

src/cpm.jl

@@ -245,6 +245,7 @@ end
     solve(problem::PertProblem)::PertResult
 
 # Arguments 
+
 - `problem::PertProblem`: The problem in type of PertProblem.
 
 # Example 

src/maximumflow.jl

@@ -26,11 +26,11 @@ end
 
 # Arguments
 
-`problem::MaximumFlowProblem`: The problem in type of MaximumFlowProblem
+- `problem::MaximumFlowProblem`: The problem in type of MaximumFlowProblem
 
 # Output
 
-`MaximumFlowResult`: The custom data type that holds path and flow.
+- `MaximumFlowResult`: The custom data type that holds path and flow.
 
 # Example
 

src/mst.jl

@@ -95,13 +95,15 @@ end
     solve(problem::MstProblem)
 
 # Arguments 
+
 - `problem::MstProblem`: The problem in type of MstProblem
 
 # Description
 
 Obtains the minimum spanning tree. 
 
 # Output 
+
 - `::MstResult`: A MstResult object that holds the results. 
 
 # Examples 

src/shortestpath.jl

@@ -31,11 +31,11 @@ Solves a shortest path problem given by an object of in type `ShortestPathProble
 
 # Arguments
 
-`problem::ShortestPathProblem`: The problem in type of ShortestPathProblem
+- `problem::ShortestPathProblem`: The problem in type of ShortestPathProblem
 
 # Output
 
-`ShortestPathResult`: The custom data type that holds path and cost.
+- `ShortestPathResult`: The custom data type that holds path and cost.
 
 # Example