From c67b710d013b3a7a0cbf2a143765689b906f5cf6 Mon Sep 17 00:00:00 2001
From: Michiel Cottaar <MichielCottaar@protonmail.com>
Date: Thu, 30 May 2024 16:13:55 +0100
Subject: [PATCH] Add missing docstrings
---
docs/src/api.md | 11 +++++++++++
docs/src/sequence_optimisation.md | 3 +++
2 files changed, 14 insertions(+)
diff --git a/docs/src/api.md b/docs/src/api.md
index 0407488..5ceda18 100644
--- a/docs/src/api.md
+++ b/docs/src/api.md
@@ -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,
]
```
diff --git a/docs/src/sequence_optimisation.md b/docs/src/sequence_optimisation.md
index e2505c2..b3469fd 100644
--- a/docs/src/sequence_optimisation.md
+++ b/docs/src/sequence_optimisation.md
@@ -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
--
GitLab