28 Repos
Tools that automatically create interactive documentation from source code annotations.
Distinguishing note: Focuses on runtime annotation parsing for documentation, distinct from static documentation generators.
Explore 28 awesome GitHub repositories matching software engineering & architecture · API Documentation Generators. Refine with filters or upvote what's useful.
This project is a comprehensive reference collection of practical implementation examples and patterns for building applications with Spring Boot. It serves as a Java web application template and a showcase for developing functional web services featuring REST endpoints, template engines, and global exception handling. The repository distinguishes itself by providing detailed demonstrations of enterprise-grade features, including distributed locking, task scheduling, and asynchronous message exchange using brokers like RabbitMQ. It also includes reference implementations for automated API doc
Provides automatic generation of interactive API documentation by scanning source code annotations.
Beego is a high-performance toolkit for building web applications and RESTful APIs using the Go programming language. It is structured as an MVC web framework that separates data models, views, and controllers to organize application logic. The project provides a comprehensive suite of integrated tools, including an object-relational mapper for translating code objects into database tables and a session manager for maintaining user identity and state across server requests. It also includes an internationalization framework for managing multilingual content and translating text based on user
Provides automated generation of interactive technical guides by parsing source code annotations and routing configurations.
Gin-vue-admin is a full-stack development scaffold designed to accelerate the creation of enterprise-grade web applications. It provides a pre-configured foundation for both backend and frontend components, incorporating a modular plugin architecture that allows developers to organize and manage application features as decoupled packages. The platform distinguishes itself through extensive automation, utilizing template-driven code generation to produce boilerplate code and interactive API documentation directly from source code annotations. It features a database-first schema mapping system
Parses source code comments and metadata at runtime to automatically construct interactive documentation for external service integration.
This project is a comprehensive educational resource and programming course covering C++ language semantics and features from C++03 through C++26. It provides structured tutorials and technical guides focused on modern C++ development. The material offers specialized instruction on template metaprogramming, including the use of type traits and compile-time computations. It features detailed guides on concurrency and parallelism for multi-core execution, as well as a reference for software design applying SOLID principles and RAII. Additionally, it covers build performance optimization to redu
Discusses the use of tools to extract annotated comments from source code to produce technical API documentation.
JSDoc is a JavaScript API documentation generator that parses comments in source code to produce structured documentation files for a project interface. It functions as a source code documentation tool that extracts metadata from code comments to automate the creation of technical API references. The system operates as a template-based documentation engine, supporting external templates to customize the visual presentation and layout of the output. It also serves as a Markdown documentation exporter, transforming extracted documentation into Markdown files for use on alternative publishing pl
Generates structured documentation from JavaScript source code comments to describe library or application interfaces.
Swag is a documentation tool for Go that generates standardized API specification files by parsing declarative annotations within source code. It functions by analyzing source files to extract metadata from comments and function signatures, transforming them into machine-readable formats such as JSON or YAML. This process ensures that technical documentation remains synchronized with the underlying code structure throughout the development lifecycle. The tool distinguishes itself through its ability to perform static source code parsing and type-system reflection, which allows it to map compl
Generates standardized OpenAPI documentation files directly from source code annotations.
apidoc is a source-code API documentation generator that parses specialized annotations within comments to automatically create a searchable API documentation website. It functions as an annotation-based API parser and a static documentation site generator, extracting definitions directly from the codebase to maintain a synchronized reference. The tool is designed as a multi-language parser, using configurable regular expressions to extract metadata from various programming languages. It can also serve as a JSON API definition exporter, converting source-code comments into raw JSON files for
Parses specialized annotations in source code to automatically generate a searchable API documentation website.
This project is a static archive of documented corporate controversies and alleged unethical actions that have been removed from local internet search results. It functions as a research platform compiling evidence of corporate misconduct for public awareness and accountability purposes, specifically focused on incidents that have been censored from search results. The archive stores each documented incident as a plain Markdown file, enabling easy editing and full version control through Git. All incident pages are pre-rendered as flat HTML files at build time for fast delivery, with a respon
Ensures all core content is accessible and readable even when JavaScript is disabled in the browser.
The minimal amount of CSS to replicate the GitHub Markdown style
Operates entirely without client-side scripting, relying solely on CSS for all visual effects and interactivity.
xmall is a distributed e-commerce platform based on a service-oriented architecture. It separates business logic into independent services that communicate over a network to ensure scalability and fault tolerance, utilizing a decoupled storefront interface for customer transactions. The platform employs a distributed architecture using Dubbo for service orchestration and Zookeeper for cluster coordination and service discovery. It integrates a specialized set of components including an asynchronous message broker for background tasks, an indexed search system for product catalogs, and a centr
Automatically generates interactive API documentation by parsing source code annotations.
Hug is a type-driven Python web framework designed for building APIs. It uses Python type annotations to automatically validate and convert incoming request data and to format outgoing responses. The framework functions as an automated documentation tool by extracting function signatures and markers from source code to generate accessible API specifications. It also supports non-blocking coroutines for asynchronous API processing to handle background tasks without interrupting the main request cycle. The project provides capabilities for REST API development, including route mapping, endpoin
Generates interactive API documentation by parsing source code annotations at runtime.
RuoYi-Vue3 is a full-stack administrative dashboard and permission management framework built with SpringBoot and Vue 3. It serves as an enterprise management backend providing a decoupled architecture that separates the API from the user interface. The project features a low-code CRUD generator that automatically produces frontend and backend boilerplate code and API documentation from database tables. It implements a comprehensive role-based access control system for managing users, departments, and granular permissions at the menu and button levels, secured by stateless JSON Web Token auth
Provides interactive API documentation generated from source code annotations.
Snap.js is a JavaScript library for building draggable side navigation panels on touch devices. It enables slide-in menus from the left or right screen edge, driven by a gesture-based state machine that interprets drag and flick gestures to open and close the panel. The library distinguishes horizontal menu drags from vertical scrolling by analyzing the initial touch movement angle, and locks menu movement to a single axis to prevent interference. It uses hardware-accelerated CSS transforms for smooth animations and provides configurable snap thresholds that determine whether a drag should op
Prevents the menu from opening when users interact with designated child elements like sliders or forms.
Documentation.js is a multi-purpose documentation tool that parses JSDoc annotations from JavaScript and TypeScript source files to generate formatted API documentation. It functions as both a documentation generator and a JSDoc linter, scanning source code for non-standard or incorrect annotations and returning human-readable warnings to enforce documentation quality. The tool operates through a pipeline-based architecture that parses JSDoc comments into an abstract syntax tree, validates annotations against style and correctness rules, and outputs documentation through interchangeable plugi
Parses JSDoc comments from source code and outputs formatted documentation in HTML, Markdown, or JSON.
This repository is a curated collection of tutorials and source code examples for learning Spring Boot development, covering a range of practical project types. It provides hands-on materials for building complete applications, including a bulletin board forum system, a full-stack blog, and a large-scale e-commerce system, as well as projects that demonstrate a decoupled frontend and backend architecture. The collection focuses on guiding developers through real-world application construction, with step-by-step tutorials and source code studies for each project. It covers fundamental Spring B
Provides tutorials that generate interactive API documentation from Spring Boot code annotations.
ts-migrate ist ein automatisiertes Migrationstool, das darauf ausgelegt ist, JavaScript-Quellcode in kompilierfähige TypeScript-Dateien zu transformieren. Es fungiert als Code-Migrations-Framework, das abstrakte Syntaxbäume (ASTs) verwendet, um großflächige Refactorings und strukturelle Änderungen an einem Projekt durchzuführen. Das Tool bietet ein anpassbares Framework zur Definition von Plugin-basierten Transformationsregeln, was die Automatisierung spezifischer Code-Änderungen ermöglicht. Es enthält spezialisierte Engines für die Konvertierung von JSDoc-Typdefinitionen in native TypeScript-Annotationen sowie ein Dienstprogramm zur Unterdrückung von Compiler-Fehlern durch das Einfügen von Typ-Assertions oder Ignore-Kommentaren. Das System deckt ein breites Spektrum an Migrationsfunktionen ab, einschließlich der Konvertierung von React-Property-Typen und Lifecycle-Methoden, der Normalisierung von Klassendefinitionen sowie der Möglichkeit, gezielt und inkrementell bestimmte Verzeichnisse durch musterbasierte Filterung zu bearbeiten.
Extracts type information from JSDoc comments and converts them into native TypeScript annotations.
Dieses Projekt ist ein umfassendes Framework für Literate Programming, das es Entwicklern ermöglicht, produktionsreife Python-Bibliotheken vollständig innerhalb von Jupyter Notebooks zu erstellen. Indem Notebooks als primäre Quelle der Wahrheit behandelt werden, integriert es Code, Dokumentation und Tests in eine einheitliche Entwicklungspipeline, die direkt in Standard-Python-Module exportiert wird. Das Framework zeichnet sich durch spezialisierte Tools aus, die darauf ausgelegt sind, die inhärenten Herausforderungen bei der Verwendung von Notebooks in der professionellen Softwareentwicklung zu überwinden. Es enthält benutzerdefinierte Git-Hooks und Merge-Driver, die volatile Notebook-Metadaten bereinigen, wodurch verrauschte Diffs effektiv eliminiert und Merge-Konflikte gelöst werden. Darüber hinaus nutzt es zellbasierte Direktiven, um Code-Sichtbarkeit, Tests und Dokumentationsgenerierung zu steuern, was es Entwicklern ermöglicht, sauberen, modularen Quellcode zu pflegen, während sie in einer interaktiven Umgebung arbeiten. Über seinen Kern-Entwicklungs-Workflow hinaus bietet das Projekt eine robuste Suite von Automatisierungstools für den gesamten Software-Lebenszyklus. Dies umfasst eine Static-Site-Engine zum Rendern von Dokumentationen in Publikationsqualität mit Unterstützung für mathematische Gleichungen und Symbol-Querverweise sowie Utilities zur Verwaltung von Projekt-Abhängigkeiten, Versionierung und automatisierten Tests. Es unterstützt zudem Continuous-Integration-Workflows zur Bereitstellung von Dokumentationen und zur Veröffentlichung von Paketen in Standard-Registries. Das Projekt bietet einen standardisierten Bootstrapping-Prozess, um neue Repositories mit vorkonfigurierten Pipelines für Tests, Dokumentation und Versionskontrolle zu initialisieren.
Renders comprehensive technical documentation by extracting function and class signatures alongside docstrings.
This project is the official Kubernetes documentation website, serving as a comprehensive technical resource for managing containerized applications. It functions as an open-source technical documentation portal that provides guides, tutorials, and reference materials for distributed systems software. The site is built using a static site generator with a component-based template architecture to maintain consistent design patterns. It features an OpenAPI documentation generator that parses technical specifications to automatically build and update structured API reference pages. To support a
Automatically generates structured API reference pages by parsing technical specifications and source code.
Crab is a memory-safe systems programming language and ahead-of-time compiler designed for high-performance software. It utilizes a type system based on strict ownership and borrowing rules to prevent memory access errors at compile time. The toolchain includes an automated documentation generator that produces technical reference manuals and API guides by parsing structured source code annotations. It also features a dependency management tool to resolve external library graphs and ensure consistent project builds. The project covers software build automation, static type checking, and mult
Provides automated API documentation generation by parsing structured annotations directly from the source code.
FastStream is an asyncio message broker framework for building event-driven applications in Python. It provides a unified interface and a multi-broker messaging abstraction layer that translates generic producer and consumer calls into broker-specific APIs. The framework features a built-in dependency injection container and uses decorators to route messages to asynchronous handler functions. It includes a documentation generator that extracts channel definitions and message formats from code to produce standardized AsyncAPI specifications. The project supports integration with Kafka, Rabbit
Automatically generates interactive AsyncAPI documentation from handler code.