Skip to content

Commit eb26162

Browse files
add mermaid class diagram to README
1 parent 31b04be commit eb26162

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

doc/README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,25 @@ binding according to the `free_interface` abstract interface defined in
88
`sp_resource_m`. The user-defined `free` subroutine must free the associated
99
resource, which usually means deallocating the associated memory.
1010

11-
![smart-pointers-class-diagram](https://user-images.githubusercontent.com/13108868/192410592-19c6e194-ac3e-4f5c-a308-33b2e10d69a7.png)
11+
```mermaid
12+
classDiagram
13+
sp_resource_t --* sp_reference_counter_t
14+
sp_resource_t : free()
15+
16+
sp_smart_pointer_t --|> sp_resource_t
17+
18+
class sp_smart_pointer_t {
19+
-counter_ : counter_t
20+
release_handle()
21+
start_counter()
22+
}
23+
24+
sp_reference_counter_t --* sp_smart_pointer_t
25+
26+
class sp_reference_counter_t {
27+
-count_ : integer, pointer
28+
-object_ : sp_resource_t
29+
grab()
30+
release()
31+
}
32+
```

0 commit comments

Comments
 (0)