#documentation #java #parser #javadoc

app lojidoc

A tool for generating documentation for java projects

5 unstable releases

Uses old Rust 2015

0.3.1 Nov 3, 2018
0.3.0 Oct 18, 2018
0.2.0 Sep 6, 2018
0.1.1 Aug 7, 2018
0.1.0 Jul 27, 2018

#1300 in Text processing

Apache-2.0

645KB
2.5K SLoC

Lojidoc

lojidoc on crates.io Build Status

About

Lojidoc is a tool for creating markdown documentation for java projects. The program parses the javadoc comments in the source code and uses the high level java declarations to provide consice and easily readable markdown documentation for each java file in the project.

Documentation

Source code documentation

Contribution

Pull requests and feature requests are always welcome. If you are opening an issue please use one of the provided issue templates as a guide. For more information about contributing read the Contribution guidelines.

Installation

Lojidoc can be installed using Cargo. The following packages are required for installation.

Note: cargo is installed by default with a rustc installation

Lojidoc can then be installed using cargo install

$ cargo install lojidoc

Once installed the default location of the executable will be ~/.cargo/bin/lojidoc

Building from source

$ git clone https://github.com/JoshBrudnak/Lojidoc.git
$ cd ./Lojidoc/
$ cargo build --release

Usage

Basic Usage

$ lojidoc [Project_Path] [FLAGS] [OPTIONS]

Example Usages

Example of passing Lojidoc the repository URL and destination directory

$ lojidoc ~/Project/src/java/ -c https://github.com/JoshBrudnak/Project/tree/master -d ~/docs/

Example of using the lint option to find javadoc mistakes and using a single thread.

$ lojidoc ~/Project/src/java/ -l -s

Note: Lojidoc will not generate any markdown files when using the lint flag

Command line arguments

Flag Description
m Use multiple threads to execute the program
l Check a java project for incorrect or missing javadocs
h Prints help information
v Generate documentation for a project and provide verbose output
V Prints the version information
Option Description
d Sets the destination directory of the created markdown files
b Create a mdbook using the generated documentation
i Ignore fields with a certain permission

Dependencies

~21–29MB
~612K SLoC