Skip to content
internal/extractors/swift
Updated
On this page

Resolving selfdoc's directives against Swift source: public declarations, doc comments and struct members, read without the Swift toolchain present.

#internal/extractors/swift

#internal/extractors/swift

Package swift resolves selfdoc's directives against Swift source.

Nothing from the Swift toolchain is required: the file is read with patterns. The four directives it serves are ref, prose-desc, table-schema and table-config.

#Explicit visibility

Swift's default visibility is internal, so what belongs on a reference page is what says public or open, and that is what the scanners look for. The one place the keyword is not required is inside a public struct, where a field is public without restating it -- and inside a symbol a page asked about by name, where the question settles what is being documented.

#Doc comments

A /// block documents the declaration directly beneath it, and Swift's own item syntax is rendered: the individual "- Parameter name:" items and the "- Parameters:" block with its indented sub-items accumulate into one section, "- Returns:" and "- Throws:" render bold labels, every callout keyword from Note to TODO renders its own, and a “Symbol“ reference becomes the code span the rest of the site writes.

#Extractor

Go go
type Extractor struct

Extractor reads Swift source.

#New

Go go
func New() extractors.Extractor

New builds the Swift extractor.

#Extractor.Detect

Go go
func (e *Extractor) Detect(dir string) bool

Detect reports whether dir is a Swift package, by its manifest.

#Extractor.FileExtensions

Go go
func (e *Extractor) FileExtensions() []string { return []string{".swift"} }

FileExtensions is the one extension Swift source carries.

#Extractor.ResolvePath

Go go
func (e *Extractor) ResolvePath(pathArg string, sourcePaths []string, baseDir string) string

ResolvePath resolves a directive's path argument to a Swift file or directory.

#Extractor.PublicSymbols

Go go
func (e *Extractor) PublicSymbols(file string) ([]string, error)

PublicSymbols lists the public and open symbols a Swift file exports.

#Extractor.ModuleDocstring

Go go
func (e *Extractor) ModuleDocstring(path string) (string, error)

ModuleDocstring is the module-level doc comment at the top of a Swift file.

#Extractor.SymbolDetails

Go go
func (e *Extractor) SymbolDetails(file, symbol string) (*extractors.SymbolDetails, error)

SymbolDetails reports what a Swift file says about one function's parameters and return value. A dotted name selects a member of a type ("Router.handle").

More tools from this site

  • claudestream Drive Claude Code from Python: run it as a subprocess and read its output as typed events, with async and sync sessions, sandbox policies, and tools you define in Python
  • claudewheel A TUI Claude Code Launcher that lets you have more than one profile, manage sessions lifecycle, pick the exact CC version, model to use (even older unlisted ones), pick which GitHub account to use, etc.
  • dirstat Fast, single-binary directory statistics CLI: every file under a tree grouped by format, with counts, sizes, and lines of code, as a colored terminal table or as JSON
  • fastware A batteries-included ASGI framework: msgspec JSON, a managed Granian server, dependency injection, SSE, WebSockets, auth, and a test client
  • go-toml-edit Zero-dep TOML editing library for Go with comment preservation
  • howmuchleft The fastest Claude Code statusline: context window, 5-hour, and weekly limit usage as three customizable gradient bars, rendering in about 6 ms
  • orxtra
  • pgdesign
  • predraw Declarative rendering pipeline: describe a scene in JSON and get SVG, PNG and WebP out, with light and dark style tokens, reusable components and text converted to path outlines
  • reposummary Turn a git repository's history into a Markdown journal: pick a time window or revision range and get a readable digest of what changed, optionally narrated by an LLM
  • rlsbl Release orchestration and project scaffolding CLI that bumps versions, validates a structured JSONL changelog, tags only the commit CI verified, and publishes to npm, PyPI, Go and more
  • safegit git wrapper CLI that gives each commit its own temporary index and retries ref updates on conflict, so concurrent agents share one repository
  • saferm Command-line replacement for rm that archives every deletion with a mandatory reason and the context it ran in, so deleted files can be listed, inspected and restored
  • strictcli
  • stricttest An always-on test-isolation floor: a pytest plugin and a Go env-hygiene module that make a test suite structurally unable to reach real credentials, the real HOME, the network, or the development repository.
  • wesktop A Python framework that turns an ASGI web app into a desktop application, serving it from a local Granian server and displaying it in a native OS window via pywebview
Search