Open Source Java Documentation Software

Doxygen is a JavaDoc like documentation system for C++, C, Java and IDL.

PlantUml allows to quickly create some UML diagram using a simple textual description language.

The DITA Open Toolkit is an implementation of the OASIS DITA XML Specification. The Toolkit transforms DITA content into many deliverable formats. See https://www.dita-ot.org/ for documentation and links to downloads. The source code and issue trackers have been moved to https://github.com/dita-ot/dita-ot

With 50+ client generators, you can easily generate code to interact with any server which exposes an OpenAPI document. Maintainers of APIs may also automatically generate and distribute clients as part of official SDKs. Each client supports different options and features, but all templates can be replaced with your own Mustache-based templates. Getting started with server development can be tough, especially if you're evaluating technologies. We can reduce the burden when you bring your own OpenAPI document. Some generators support Inversion of Control, allowing you to iterate on design via your OpenAPI document without worrying about blowing away your entire domain layer when you regenerate code. Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious? OpenAPI documents allow you to convert the metadata about your API into some other format.

Java provides the concurrent library that simplifies concurrent programming, but this is hard to learn and visualize. This project is a series of animations each illustrating the coding and usage of a component in the java concurrent library.

Requirements management tool designed to achieve full SDLC traceability for features, requirements, design, implementation and testing. UI for requirements derivation, version control, attributes etc. Upgrade path also available at https://sourceforge.net/projects/nimble

Swagger-Codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition. Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset. Find out how Swagger can help you design and document your APIs at scale. The power of Swagger tools starts with the OpenAPI Specification, the industry standard for RESTful API design. Individual tools to create, update and share OpenAPI definitions with consumers. SwaggerHub is the platform solution to support OpenAPI workflows at scale. Swagger open source and pro tools have helped millions of API developers, teams, and organizations deliver great APIs. If the OpenAPI/Swagger spec is obtained from an untrusted source, please make sure you've reviewed the spec before using Swagger Codegen to generate the API client, server stub or documentation as code injection may occur.

This Java application serves to transform W3C XML Schema instances into interactive diagrams in SVG format. The diagram represents structure of XML files and provides information about individual items – elements and attributes.

This is a new code repository for SchemaSpy tool initially created and maintained by John Currier. I personally believe that work on SchemaSpy should be continued, and a lot of still existing issues should be resolved. Last released version of the SchemaSpy was in 2010, and I have a plan to change this. Process of installation is very simple because SchemaSpy is only one Java .jar application. You can learn more read the installation doc. When you environment will be ready, and you can start using SchemaSpy you can read more about the configuration. Browse some sample pages generated by SchemaSpy. Note that this was run against an extremely limited schema so it doesn't show the full power of the tool.

A reStructuredText editor plugin for Eclipse. This project aims to provide a good support for Sphinx documentation generation in the Eclipse IDE.

SonicReader is used to view and save reports of the internals of a Sonicwall Configuration file. This is useful for those people that wish to know the settings within their saved Sonicwall Configs. I have no affiliation with Dell Sonicwall. Please do not contact Dell Sonicwall regarding the use of this program.

CatMDEdit is a metadata editor tool for describing resources, mainly geographic information. Developed by IAAA (University of Zaragoza) and GeoSpatiumLab S.L., sponsored by IGN Spain. Technical details: Java, XML, multiplatform, multilingual.

DEP4E integrates DocBook XML and DocBook XSL into Eclipse IDE to create, edit and process DocBook projects.

A fast and reliable tool, written in Java 8, for generating professional UML sequence diagrams from text. Supports actors, con-/destructors, threads, broadcasts, notes, and fragments. Can serve as a Javadoc taglet. Exports PDF, (E)PS, SVG, PNG, ... The source code is hosted at http://github.com/sdedit/sdedit

Free video screencam tutorials for Eclipse and Java. Includes "Eclipse and Java for Total Beginners", "Using the Eclipse Workbench", "Introducing Persistence", and "Using the Debugger". Intended for beginning and intermediate users and programmer. You can view the Total Beginners tutorials on Youtube at https://www.youtube.com/playlist?list=PLv6UtFrA7VEu4PtzJaGHHSeZBi6mdJtwv. You can read descriptions and download all of the tutorials at http://eclipsetutorial.sourceforge.net.

The primary goal of this project is to simplify the generation of up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-UI and can be served as static content. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specifications. Internally it uses the official swagger-parser and my markup-document-builder. You can use Swagger2Markup to convert your contract-first Swagger YAML file into a human-readable format.

StatSVN is a metrics-analysis tool for charting software evolution through analysis of Subversion source repositories.

Allows to generate a wiki (interlinked HTML files) from a bunch of XML formatted files. It also allows to add a Help-system to a Swing or JavaFX application. Also it is also possible to generate a PDF, Word (docx), or epub document rather than a wiki. The tool also provides a visual editor to edit the wiki. The project also support both the Mediawiki and Markdown syntax.

PlantUml Dependency allows to parse / reverse engineering source files (only Java is supported by now) to generate a PlantUml description, allowing to draw the UML class diagram associated to the source code.

Texlipse is a plugin that adds Latex editing support for the popular Eclipse Java IDE. Key features include: syntax highlight, command completion, bibliography completion, outline navigation and automatic building.

Docmenta is a Java web-application for single source publishing and help authoring. The application allows collaborative creation of documentation, e-books and online-help. Supported output formats are PDF, HTML, WebHelp, EPUB (eBook) and DocBook. For more information, visit: http://www.docmenta.org

DEFT, the Development Environment For Tutorials, allows you to easily write and maintain tutorials which contain source code examples. If the code you're documenting changes, your examples in the tutorial will change as well.

Experimental browser that natively supports HTML, PDF, man pages, TeX DVI, scanned paper. Annotate with hyperlinks, highlights, notes, executable copy editor markup. [PDF tools for compress, impose, decrypt/encrypt, split/merge have been moved.]

Piggydb is a flexible and scalable knowledge building platform that supports a heuristic or bottom-up approach to discover new concepts or ideas based on your input. You can begin with using it as a flexible outliner, diary or notebook, and as your database grows, Piggydb helps you to shape or elaborate your own knowledge. Piggydb is a Web application provided as a self-contained package that contains a Web server and database engine. With Piggydb, you can create highly structured content by connecting knowledge fragments to each other to build a network structure, which is more flexible and expressive than a tree structure. Fragments can also be classified using hierarchical tags.

JAutodoc is an Eclipse Plugin for automatically adding Javadoc and file headers to your source code. It is possible to define Velocity templates for Javadoc and file headers. Wiki: https://github.com/mkesting/jautodoc/wiki Source Code: https://github.com/mkesting/jautodoc/ Update Site: https://dl.bintray.com/mkesting/jautodoc/update/latest/