Skip to content

Commit 82b1aa5

Browse files
authored
Add macros to docs (#88)
* Add macros to docs * Bump version
1 parent 7f5c74d commit 82b1aa5

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "StructTypes"
22
uuid = "856f2bd8-1eba-4b0a-8007-ebc267875bd4"
33
authors = ["Jacob Quinn"]
4-
version = "1.10.0"
4+
version = "1.10.1"
55

66
[deps]
77
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

docs/src/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,3 +155,24 @@ StructTypes.mapfields!
155155
StructTypes.applyfield!
156156
StructTypes.applyfield
157157
```
158+
159+
## Macros
160+
161+
The `StructType` of a type can be set using the following utility macros
162+
163+
164+
```@docs
165+
StructTypes.@Struct
166+
```
167+
168+
And similarly for
169+
- `StructTypes.@Mutable`
170+
- `StructTypes.@CustomStruct`
171+
- `StructTypes.@OrderedStruct`
172+
- `StructTypes.@AbstractType`
173+
- `StructTypes.@DictType`
174+
- `StructTypes.@ArrayType`
175+
- `StructTypes.@StringType`
176+
- `StructTypes.@NumberType`
177+
- `StructTypes.@BoolType`
178+
- `StructTypes.@NullType`

0 commit comments

Comments
 (0)