GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - ranjanakarsh/Swift-API-Extractor: Extracts a structured summary (including doc comments) of all classes, structs, protocols, enums, typealiases, variables, and functions from all .swift files in a directory (recursively). Optimized for LLM ingestion and codebase documentation.

BranchesTags
Open more actions menu

Latest commit

 

History

3 Commits
3 Commits

Folders and files

NameName
Last commit message
Last commit date
LICENSE
LICENSE
 
 
README.md
README.md
 
 
swift_api_extractor.py
swift_api_extractor.py
 
 

Repository files navigation

Swift API Extractor

Extract a structured summary (including doc comments) of all classes, structs, protocols, enums, typealiases, variables, and functions from every .swift file in a directory.
Optimized for LLM (Large Language Model) understanding and codebase documentation.

Features

  • Lists all types, protocols, enums, functions, and variables (with signatures)
  • Includes documentation comments, inheritance, protocol conformances, and enum cases
  • Outputs a readable summary for LLMs, onboarding, or documentation

Requirements

  • macOS (or Linux with Swift toolchain)
  • SourceKitten:
    Install via Homebrew:
    brew install sourcekitten
  • Python 3.7+

Usage

python swift_api_extractor.py -d /path/to/your/swift/project -o summary.txt

Example Output

# File: ./Features/Auth/AuthRepository.swift

protocol AuthRepository
  Doc: Provides a layer between AuthService and the rest of the app, mapping errors and handling business logic...
  func signIn(email:password:)() -> Result<User, AuthError>
    Doc: Signs in a user with the given email and password.
...

License

MIT

About

Extracts a structured summary (including doc comments) of all classes, structs, protocols, enums, typealiases, variables, and functions from all .swift files in a directory (recursively). Optimized for LLM ingestion and codebase documentation.

Topics

apiapi-summaryautomationcode-analysiscode-documentationcode-introspectioncontext-extractiondeveloper-toolsdocumentationlarge-language-modelsllmsourcekittenswiftswift-packageswiftuixcode

Resources

Readme
MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.