Skip to content
Snippets Groups Projects
Unverified Commit c67b710d authored by Michiel Cottaar's avatar Michiel Cottaar
Browse files

Add missing docstrings

parent 7d116577
No related branches found
No related tags found
1 merge request!2Define variables through new @defvar macro
Pipeline #24153 passed
......@@ -3,6 +3,9 @@ CollapsedDocStrings = true
```
# MRIBuilder.jl internal API
```@docs
MRIBuilder
```
## Type diagram
```@eval
import MRIBuilder.Variables: AbstractBlock
......@@ -31,6 +34,7 @@ Modules = [
MRIBuilder.Components.Pulses.InstantPulses,
MRIBuilder.Components.Pulses.ConstantPulses,
MRIBuilder.Components.Pulses.SincPulses,
MRIBuilder.Components.Pulses.CompositePulses,
MRIBuilder.Components.Readouts,
MRIBuilder.Components.Readouts.ADCs,
MRIBuilder.Components.Readouts.SingleReadouts,
......@@ -63,6 +67,13 @@ Modules = [
Modules = [
MRIBuilder.SequenceIO,
MRIBuilder.SequenceIO.Pulseq,
MRIBuilder.SequenceIO.PulseqIO,
MRIBuilder.SequenceIO.PulseqIO.Types,
MRIBuilder.SequenceIO.PulseqIO.Parsers,
MRIBuilder.SequenceIO.PulseqIO.BasicParsers,
MRIBuilder.SequenceIO.PulseqIO.Components,
MRIBuilder.SequenceIO.PulseqIO.SectionsIO,
MRIBuilder.SequenceIO.PulseqIO.ParseSections,
]
```
......
......@@ -16,6 +16,9 @@ All variables are available as members of the [`variables`](@ref) structure.
```@meta
CollapsedDocStrings = true
```
```@docs
variables
```
```@docs; canonical=false
variables.N_left
variables.N_right
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment