Skip to content

Instantly share code, notes, and snippets.

@stefanbirkner
Created October 19, 2014 17:29
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save stefanbirkner/46a6a8df3ff6cbf253db to your computer and use it in GitHub Desktop.
Save stefanbirkner/46a6a8df3ff6cbf253db to your computer and use it in GitHub Desktop.
Readme of semantic wrapper.

Semantic Wrapper

Generates classes that wrap other classes. Such wrapper classes can be used for named parameters in order to write better code.

Installation

The Semantic Wrapper Maven plugin is available from Maven Central.

<plugin>
  <groupId>com.github.stefanbirkner</groupId>
  <artifactId>semantic-wrapper-maven-plugin</artifactId>
  <version>0.5.0</version>
</plugin>

The core library is available from Maven Central, too.

<dependency>
  <groupId>com.github.stefanbirkner</groupId>
  <artifactId>semantic-wrapper</artifactId>
  <version>0.5.0</version>
</dependency>

Documentation

The documentation is hosted by GitHub pages at Semantic Wrapper Homepage. It is generated from the gh-pages branch. Please use Jekyll if you want to access the documentation on your own machine.

jekyll --serve

Development Guidelines

This project is build with Maven. Please verify that your change doesn't break anything.

mvn verify javadoc:javadoc -Dgpg.skip

You don't have to care about the coding style. We just uns vorbehalten to reformat your code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment