Giter Club home page Giter Club logo

pax's Introduction

Pax

Latest Version

0.1

Description

A project to help you write interfaces only once, and generate the proper files in different languages.

Pom.xml information

In order to use this plugin, add the following dependency to your pom.xml

<dependency>
	<groupId>ca.mestevens.java</groupId>
	<artifactId>pax</artifactId>
	<version>0.1</version>
</dependency>

Documentation

Sample JSON Format

{
	"javaOutputFolder": "java",
	"objcOutputFolder": "objc",
	"classes": [
		{
			"className": "HelloPerson",
			"javaMetadata": {
				"namespace": "com.example.test",
				"className": "HelloPerson",
				"outputFolder": "src/main/java/com/example/test"
			},
			"objcMetadata": {
				"className": "MESHelloPerson",
				"outputFolder": "src"
			},
			"description": "A class that lets you say hello to a person!",
			"methods": [
				{
					"name": "hello",
					"return": "string",
					"returnDescription": "A string saying hello to the person",
					"description": "Says hello to a person",
					"params": [
						{
							"type": "string",
							"name": "name",
							"description": "Name of the person you're saying hello to.",
							"modifier": "const"
						}
					]
				}
			]
		}
	]
}

Output

Java

package com.example.test;

/**
 * A class that lets you say hello to a person!
 */
public interface HelloPerson {

	/**
	 * Says hello to a person
	 * @param name Name of the person you're saying hello to.
	 * @return A string saying hello to the person
	 */
	public String hello(final String name);

}

Objective-C

#import <Foundation/Foundation.h>

/**
 * A class that lets you say hello to a person!
 */
@protocol MESHelloPerson <NSObject>

@required

/**
 * Says hello to a person
 * @param name Name of the person you're saying hello to.
 * @return A string saying hello to the person
 */
- (NSString*)hello:(NSString* const)name;

@end

pax's People

Watchers

James Cloos avatar

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.