Git Product home page Git Product logo

imgdoc's Introduction

ImgDoc

Java library which generates graphic documentation/scheme of source code that is saved as a PNG image.

Features:

  • customizable
  • pretty annotations

Usage

Adding methods and classes to documentation:

@Draw(
        author = "Developer 1",
        version = "1.1 Stable",
        description = "This is example class"
)
public class ExampleClass {

    @Draw(
            author = "Developer 2/Developer 3"
            version = "0.4",
            description = "Some description..."
    )
    private String returnString(String text) {
        return text;
    }
    //...
}

Initializing and customizing output of graphic documentation:

public class ExampleClass {
    public static void main(String[] args) {
        ImgDoc imgDoc = new ImgDoc.DocBuilder()
                .setPNGFileName("doc_exampleClass.png")
                .setWidth(1400)
                .setHeight(800)
                .init();
        imgDoc.draw(ExampleClass.class);
    }
    
    //...
}

Available customizing methods:

DocBuilder().setPNGFileName(String fileName)
DocBuilder().setWidth(int width)
DocBuilder().setHeight(int height)

Explanations:

  • setPNGFileName() - sets name of output PNG image
  • setWidth() - sets width of output image
  • setHeight() - sets height of output image

After customization invoke init() on it to save all settings. To generate image, call:

ImgDoc().draw(Class<?> obj)

on instance of ImgDoc class. Generated documentation will be saved in main directory of project with name specified in setPNGFileName() method.

Example output

Image 1

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.