Skip to content

Commit 8e9eee7

Browse files
committed
Adding API docs.
1 parent 0d266d2 commit 8e9eee7

File tree

1 file changed

+18
-59
lines changed

1 file changed

+18
-59
lines changed

docs/src/api.md

Lines changed: 18 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,50 @@
11
# API
22

3-
# Express
4-
5-
This part contains basic convenience functions for creating and running Mango.jl simulations.
6-
7-
```@autodocs
8-
Modules = [Mango]
9-
Private = false
10-
Pages = ["express/api.jl"]
11-
```
12-
13-
# Agent and Roles
14-
15-
Here, the API for the agent structs created with @agent/@role is listed.
16-
17-
```@autodocs
18-
Modules = [Mango]
19-
Private = false
20-
Pages = ["agent/api.jl", "agent/core.jl", "agent/role.jl", "agent/services.jl"]
21-
Order = [:macro, :function, :constant, :type, :module]
22-
```
23-
24-
# Real time container
25-
26-
This part contains the API related to the container construction, access and management.
3+
# Algorithm Core Functions
274

285
```@autodocs
29-
Modules = [Mango]
6+
Modules = [DistributedResourceOptimization]
307
Private = false
31-
Pages = ["container/api.jl", "container/core.jl", "container/mqtt.jl", "container/protocol.jl", "container/tcp.jl"]
8+
Pages = ["algorithm/core.jl"]
329
```
3310

34-
# Simulation
35-
36-
In the following the APIs regarding the simulation world are listed.
11+
# Carrier Core
3712

3813
```@autodocs
39-
Modules = [Mango]
14+
Modules = [DistributedResourceOptimization]
4015
Private = false
41-
Pages = ["simulation/container.jl", "simulation/communication.jl", "simulation/tasks.jl", "simulation/world.jl"]
16+
Pages = ["carrier/core.jl"]
4217
```
4318

44-
# Simulation Environment
45-
46-
In the following the APIs regarding the simulation environment are listed.
19+
# Mango Carrier
4720

4821
```@autodocs
49-
Modules = [Mango]
22+
Modules = [DistributedResourceOptimization]
5023
Private = false
51-
Pages = ["environment/api.jl", "environment/core.jl"]
24+
Pages = ["carrier/mango.jl"]
5225
```
5326

54-
# Scheduling
5527

56-
In the following the APIs for scheduling TaskData is listed.
28+
# ADMM Sharing
5729

5830
```@autodocs
59-
Modules = [Mango]
31+
Modules = [DistributedResourceOptimization]
6032
Private = false
61-
Pages = ["util/scheduling.jl"]
33+
Pages = ["algorithm/admm/sharing_admm.jl"]
6234
```
6335

64-
# Topology
65-
66-
In the following the APIs for creating, aplying and using topologies is listed.
36+
# ADMM Consensus
6737

6838
```@autodocs
69-
Modules = [Mango]
39+
Modules = [DistributedResourceOptimization]
7040
Private = false
71-
Pages = ["util/topology.jl"]
41+
Pages = ["algorithm/admm/consensus_admm.jl"]
7242
```
7343

74-
# Encoding/Decoding
75-
76-
In the following the built-in functions for encoding and decoding messages are listed.
44+
# ADMM Flex
7745

7846
```@autodocs
79-
Modules = [Mango]
47+
Modules = [DistributedResourceOptimization]
8048
Private = false
81-
Pages = ["util/encode_decode.jl"]
49+
Pages = ["algorithm/admm/conflex_actor.jl"]
8250
```
83-
84-
# Misc
85-
86-
87-
```@autodocs
88-
Modules = [Mango]
89-
Private = false
90-
Pages = ["util/datastructures_util.jl"]
91-
```

0 commit comments

Comments
 (0)