2 dépôts
The process of creating searchable technical references for classes and methods.
Distinct from PHP API Documentation Libraries: The parent focuses on the libraries that extract metadata; the child focuses on the actual generation of the searchable reference.
Explore 2 awesome GitHub repositories matching web development · API Reference Generation. Refine with filters or upvote what's useful.
phpDocumentor est un générateur de documentation API PHP et un analyseur de code source qui transforme les fichiers PHP et les DocBlocks en références API HTML structurées. Il fonctionne comme un générateur de site statique et un outil de documentation automatique conçu pour synchroniser la documentation technique avec les changements de code. Le projet se distingue en agissant comme un générateur de diagrammes UML, produisant des graphiques de classes et d'architecture via PlantUML basés sur l'analyse du code source. Il prend également en charge la rédaction de manuels techniques, rendant des guides écrits à la main en Markdown et ReStructuredText aux côtés des références API générées automatiquement. L'outil fournit de larges capacités pour l'analyse du code source, y compris la génération d'arbres de syntaxe abstraits, le marquage de métadonnées et la gestion de l'héritage de la documentation. Il inclut des outils de visualisation pour l'architecture du code, le contrôle de la visibilité des éléments et la gestion de la documentation versionnée. Les builds peuvent être gérés via des fichiers de configuration XML pour automatiser la génération au sein des pipelines d'intégration continue.
Automatically generates searchable technical references for PHP classes and methods from source code and comments.
dumi is a static site generator and markdown-based documentation tool specifically designed for software component libraries. It transforms markdown files and source code into structured technical guides and API references. The project distinguishes itself by providing an interactive component playground that renders live, runnable code demos directly in the browser. It includes an automated API reference generator that parses source code to create documentation tables and property descriptions. Additionally, it supports a monorepo documentation workflow with source mapping and hot module rep
Automatically parses source code to generate documentation tables and property descriptions for components.