Directories
¶
| Path | Synopsis |
|---|---|
|
Package config loads defSource runtime configuration from environment variables.
|
Package config loads defSource runtime configuration from environment variables. |
|
Package crawler implements a concurrent documentation crawler that fetches, parses, and indexes entities from a source adapter into a store.
|
Package crawler implements a concurrent documentation crawler that fetches, parses, and indexes entities from a source adapter into a store. |
|
Package docparser provides a unified documentation comment parsing infrastructure with sub-packages for each documentation format across multiple programming languages.
|
Package docparser provides a unified documentation comment parsing infrastructure with sub-packages for each documentation format across multiple programming languages. |
|
doxygen
Package doxygen parses C/C++ Doxygen documentation comments into structured DocComment values.
|
Package doxygen parses C/C++ Doxygen documentation comments into structured DocComment values. |
|
godoc
Package godoc parses Go doc comments into structured DocComment values.
|
Package godoc parses Go doc comments into structured DocComment values. |
|
javadoc
Package javadoc parses JavaDoc comment blocks (/** ...
|
Package javadoc parses JavaDoc comment blocks (/** ... |
|
jsdoc
Package jsdoc parses JSDoc comment blocks (/** ...
|
Package jsdoc parses JSDoc comment blocks (/** ... |
|
phpdoc
Package phpdoc parses PHPDoc comment blocks (/** ...
|
Package phpdoc parses PHPDoc comment blocks (/** ... |
|
pydoc
Package pydoc parses Python docstrings into structured DocComment values.
|
Package pydoc parses Python docstrings into structured DocComment values. |
|
rustdoc
Package rustdoc parses Rust documentation comments (/// and //!) into structured DocComment values.
|
Package rustdoc parses Rust documentation comments (/// and //!) into structured DocComment values. |
|
xmldoc
Package xmldoc parses C# XML documentation comments (/// lines or /** ...
|
Package xmldoc parses C# XML documentation comments (/// lines or /** ... |
|
yard
Package yard parses Ruby YARD documentation comments into structured DocComment values.
|
Package yard parses Ruby YARD documentation comments into structured DocComment values. |
|
Package search provides ranking, formatting, and token-counting utilities for documentation query results returned by the defSource library.
|
Package search provides ranking, formatting, and token-counting utilities for documentation query results returned by the defSource library. |
|
Package server provides the HTTP API server for defSource.
|
Package server provides the HTTP API server for defSource. |
|
Package source defines the Source interface and the data-transfer types that flow between a source adapter and the crawler.
|
Package source defines the Source interface and the data-transfer types that flow between a source adapter and the crawler. |
|
allsources
Package allsources is a convenience import that triggers init() registration of all language source adapters into the default registry.
|
Package allsources is a convenience import that triggers init() registration of all language source adapters into the default registry. |
|
clang
Package clang provides a documentation source adapter that parses C library source code from a local checkout of any C project (glibc, SQLite, OpenSSL, libcurl, etc.).
|
Package clang provides a documentation source adapter that parses C library source code from a local checkout of any C project (glibc, SQLite, OpenSSL, libcurl, etc.). |
|
cpp
Package cpp provides a documentation source adapter that parses C++ library source code from a local clone of any C++ GitHub repository (Boost, Qt, Abseil, etc.).
|
Package cpp provides a documentation source adapter that parses C++ library source code from a local clone of any C++ GitHub repository (Boost, Qt, Abseil, etc.). |
|
csharp
Package csharp provides a documentation source adapter that reads C# source code from a local clone of a .NET/ASP.NET/EF Core GitHub repository.
|
Package csharp provides a documentation source adapter that reads C# source code from a local clone of a .NET/ASP.NET/EF Core GitHub repository. |
|
golang
Package golang provides a Source interface implementation for parsing Go source code.
|
Package golang provides a Source interface implementation for parsing Go source code. |
|
java
Package java provides a documentation source adapter that reads Java source code from a local clone of a GitHub repository.
|
Package java provides a documentation source adapter that reads Java source code from a local clone of a GitHub repository. |
|
javascript
Package javascript provides a documentation source adapter that reads JavaScript source code from a local directory (downloaded from GitHub).
|
Package javascript provides a documentation source adapter that reads JavaScript source code from a local directory (downloaded from GitHub). |
|
php
Package php — ast.go: tree-sitter PHP AST walker and wrapper detector.
|
Package php — ast.go: tree-sitter PHP AST walker and wrapper detector. |
|
python
Package python provides a documentation source adapter that reads Python source code from a local checkout of a Python framework repository (Django, Flask, FastAPI, etc.).
|
Package python provides a documentation source adapter that reads Python source code from a local checkout of a Python framework repository (Django, Flask, FastAPI, etc.). |
|
ruby
Package ruby provides a documentation source adapter that reads Ruby source code from a local checkout of a Ruby framework repository (Rails, RSpec, Sidekiq, etc.).
|
Package ruby provides a documentation source adapter that reads Ruby source code from a local checkout of a Ruby framework repository (Rails, RSpec, Sidekiq, etc.). |
|
rust
Package rust provides a documentation source adapter that reads Rust source code from a local checkout of any Rust crate repository.
|
Package rust provides a documentation source adapter that reads Rust source code from a local checkout of any Rust crate repository. |
|
typescript
Package typescript provides a Source interface implementation for parsing TypeScript source code from any TypeScript-based library (Angular, NestJS, RxJS, Zod, etc.).
|
Package typescript provides a Source interface implementation for parsing TypeScript source code from any TypeScript-based library (Angular, NestJS, RxJS, Zod, etc.). |
|
Package store defines the persistence interface and data-transfer types used by all storage backends.
|
Package store defines the persistence interface and data-transfer types used by all storage backends. |
Click to show internal directories.
Click to hide internal directories.