28 repository-uri
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 este un generator de documentație API din codul sursă care analizează adnotările specializate din comentarii pentru a crea automat un site de documentație API căutabil. Funcționează ca un parser API bazat pe adnotări și un generator de site-uri de documentație statică, extrăgând definițiile direct din codebase pentru a menține o referință sincronizată. Instrumentul este conceput ca un parser multi-limbaj, folosind expresii regulate configurabile pentru a extrage metadate din diverse limbaje de programare. Poate servi, de asemenea, ca exportator de definiții API JSON, convertind comentariile din codul sursă în fișiere JSON brute pentru utilizare în scheme externe sau șabloane personalizate. Dincolo de generarea de bază, sistemul suportă layout-uri de documentație personalizate, filtre de vizibilitate pentru metode private sau depreciate și posibilitatea de a testa endpoint-uri API live direct din interfața generată. Fluxul de lucru poate fi automatizat prin monitorizarea fișierelor sursă pentru modificări, declanșând regenerarea în timp real. Generatorul poate fi executat prin interfața linie de comandă, rulat programatic ca bibliotecă sau implementat folosind un container Docker.
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 este un instrument de migrare automatizat conceput pentru a transforma codul sursă JavaScript în fișiere TypeScript care pot fi compilate. Funcționează ca un framework de migrare a codului care utilizează arbori de sintaxă abstractă (AST) pentru a efectua refactorizări la scară largă și modificări structurale într-un proiect. Instrumentul oferă un framework personalizabil pentru definirea regulilor de transformare bazate pe plugin-uri, permițând automatizarea unor modificări specifice de cod. Include motoare specializate pentru conversia definițiilor de tip JSDoc în adnotări native TypeScript și un utilitar pentru suprimarea erorilor de compilare prin inserarea de aserțiuni de tip sau comentarii de ignorare. Sistemul acoperă o gamă largă de capabilități de migrare, inclusiv conversia tipurilor de proprietăți React și a metodelor de ciclu de viață, normalizarea definițiilor de clasă și capacitatea de a viza incremental directoare specifice prin filtrare bazată pe tipare.
Extracts type information from JSDoc comments and converts them into native TypeScript annotations.
Acest proiect este un framework cuprinzător pentru literate programming care permite dezvoltatorilor să construiască biblioteci Python gata de producție în întregime în Jupyter Notebooks. Tratând notebook-urile ca sursă principală de adevăr, acesta integrează codul, documentația și testarea într-un pipeline de dezvoltare unificat care exportă direct către module Python standard. Framework-ul se distinge prin instrumente specializate concepute pentru a depăși provocările inerente utilizării notebook-urilor în ingineria software profesională. Include Git hooks personalizate și merge drivers care igienizează metadatele volatile ale notebook-urilor, eliminând eficient diff-urile zgomotoase și rezolvând conflictele de merge. Mai mult, utilizează directive bazate pe celule pentru a controla vizibilitatea codului, testarea și generarea documentației, permițând dezvoltatorilor să mențină un cod sursă curat și modular în timp ce lucrează într-un mediu interactiv. Dincolo de fluxul său de lucru de dezvoltare de bază, proiectul oferă o suită robustă de instrumente de automatizare pentru întregul ciclu de viață software. Aceasta include un motor de site static pentru randarea documentației de nivel de publicare cu suport pentru ecuații matematice și referințe încrucișate de simboluri, precum și utilitare pentru gestionarea dependențelor proiectului, versionare și testare automată. De asemenea, suportă fluxuri de lucru de integrare continuă (CI) pentru implementarea documentației și publicarea pachetelor în registre standard. Proiectul oferă un proces de bootstrapping standardizat pentru a inițializa noi repository-uri cu pipeline-uri pre-configurate pentru testare, documentație și version control.
Renders comprehensive technical documentation by extracting function and class signatures alongside docstrings.
Acest proiect este site-ul oficial de documentație Kubernetes, servind drept resursă tehnică cuprinzătoare pentru gestionarea aplicațiilor containerizate. Funcționează ca un portal de documentație tehnică open-source care oferă ghiduri, tutoriale și materiale de referință pentru software-ul de sisteme distribuite. Site-ul este construit folosind un generator de site-uri statice cu o arhitectură de template-uri bazată pe componente pentru a menține tipare de design consistente. Dispune de un generator de documentație OpenAPI care parsează specificațiile tehnice pentru a construi și actualiza automat pagini de referință API structurate. Pentru a susține o audiență globală, utilizează rutarea conținutului conștientă de internaționalizare pentru a gestiona versiunile localizate ale manualelor. Fluxul de lucru de dezvoltare include un server cu hot-reloading pentru previzualizarea modificărilor site-ului și randarea țintită a limbajului pentru a accelera timpii de build. Proiectul acoperă o gamă largă de domenii tehnice, inclusiv orchestrarea clusterelor, configurarea rețelei și gestionarea resurselor.
Automatically generates structured API reference pages by parsing technical specifications and source code.
Crab este un limbaj de programare de sistem sigur pentru memorie și un compilator ahead-of-time conceput pentru software de înaltă performanță. Utilizează un sistem de tipuri bazat pe reguli stricte de ownership și borrowing pentru a preveni erorile de acces la memorie la momentul compilării. Toolchain-ul include un generator automat de documentație care produce manuale de referință tehnică și ghiduri API prin parsarea adnotărilor structurate din codul sursă. De asemenea, dispune de un instrument de gestionare a dependențelor pentru a rezolva grafurile bibliotecilor externe și a asigura build-uri consistente ale proiectelor. Proiectul acoperă automatizarea build-ului software, verificarea statică a tipurilor și analiza statică multi-pass pentru a verifica constrângerile înainte de a genera binare native pentru mașină.
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.