Structure

Semantic.Analyses.HasOnlySequentialHeadings

Checks for any direct heading children that do not meet the minimum heading level (startingFromLevel) or that exceed the level of a previous valid heading by more than one.

struct HasOnlySequentialHeadings<Parent> where Parent : Semantic, Parent : DirectiveConvertible

Discussion

For example, when startingFromLevel is 2:

# H1 <- invalid, too low
## H2 <- valid, meets minimum
## H2 <- valid, equal to previous valid
### H3 <- valid, one more than previous
#### H4 <- valid, one more than previous
## H2 <- valid, exceeds minimum heading level
#### H4 <- invalid, skips H3 heading level

Topics

Initializers

init(severityIfFound: DiagnosticSeverity?, startingFromLevel: Int)

Instance Methods

func analyze(BlockDirective, children: some Sequence<any Markup>, source: URL?, for: DocumentationBundle, problems: inout [Problem]) -> [Heading]
Returns all valid headings.