From 12e775d64d9da2f5d337f0f5bc8e9782b3f38679 Mon Sep 17 00:00:00 2001
From: Athou <jeremiepanzer@gmail.com>
Date: Mon, 15 Apr 2013 14:47:37 +0200
Subject: [PATCH] added enunciate for doc generation

---
 pom.xml                                       | 24 +++++++++++++++-
 src/main/enunciate/enunciate.xml              | 28 +++++++++++++++++++
 .../backend/model/ApplicationSettings.java    |  9 ++++++
 .../commafeed/frontend/model/Category.java    |  6 ++++
 .../com/commafeed/frontend/model/Entries.java |  6 ++++
 .../com/commafeed/frontend/model/Entry.java   |  6 ++++
 .../commafeed/frontend/model/MarkRequest.java |  6 ++++
 .../model/ProfileModificationRequest.java     |  6 ++++
 .../frontend/model/RegistrationRequest.java   |  6 ++++
 .../commafeed/frontend/model/Settings.java    |  6 ++++
 .../frontend/model/Subscription.java          |  6 ++++
 .../frontend/model/SubscriptionRequest.java   |  6 ++++
 .../commafeed/frontend/model/UserModel.java   |  6 ++++
 .../rest/resources/AdminSettingsREST.java     |  4 +--
 14 files changed, 121 insertions(+), 4 deletions(-)
 create mode 100644 src/main/enunciate/enunciate.xml

diff --git a/pom.xml b/pom.xml
index 404c5a40..960eb1cb 100644
--- a/pom.xml
+++ b/pom.xml
@@ -138,6 +138,22 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>org.codehaus.enunciate</groupId>
+				<artifactId>maven-enunciate-plugin</artifactId>
+				<version>1.26.2</version>
+				<executions>
+					<execution>
+						<id>package</id>
+						<goals>
+							<goal>assemble</goal>
+						</goals>
+						<configuration>
+							<configFile>${project.basedir}/src/main/enunciate/enunciate.xml</configFile>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
 			<plugin>
 				<groupId>com.github.searls</groupId>
 				<artifactId>jasmine-maven-plugin</artifactId>
@@ -287,7 +303,13 @@
 			<artifactId>wicket-cdi</artifactId>
 			<version>6.6.0</version>
 		</dependency>
-	
+
+		<dependency>
+			<groupId>org.codehaus.enunciate</groupId>
+			<artifactId>enunciate-core-annotations</artifactId>
+			<version>1.26.2</version>
+		</dependency>
+
 		<dependency>
 			<groupId>junit</groupId>
 			<artifactId>junit</artifactId>
diff --git a/src/main/enunciate/enunciate.xml b/src/main/enunciate/enunciate.xml
new file mode 100644
index 00000000..73503a2f
--- /dev/null
+++ b/src/main/enunciate/enunciate.xml
@@ -0,0 +1,28 @@
+<enunciate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:noNamespaceSchemaLocation="
+           http://enunciate.codehaus.org/schemas/enunciate-1.26.xsd">
+	
+	<modules>
+		<disable-rule id="csharp.warnings" />
+		<disable-rule id="c.warnings" />
+		<disable-rule id="obj-c.warnings" />
+		<docs docsDir="api" includeExampleXml="false" includeExampleJson="true"
+			includeDefaultDownloads="false" forceExampleJson="true" defaultNamespace=""
+			disableRestMountpoint="true">
+		</docs>
+		<!-- Disable all the client generation tools -->
+		<basic-app disabled="true" />
+		<c disabled="true" />
+		<csharp disabled="true" />
+		<java-client disabled="true" />
+		<jaxws-client disabled="true" />
+		<jaxws-ri disabled="false" />
+		<jaxws-support disabled="false" />
+		<jersey disabled="true" />
+		<obj-c disabled="true" />
+		<xml disabled="true" />
+		<jaxws disabled="true" />
+		<amf disabled="true" />
+	</modules>
+
+</enunciate>
\ No newline at end of file
diff --git a/src/main/java/com/commafeed/backend/model/ApplicationSettings.java b/src/main/java/com/commafeed/backend/model/ApplicationSettings.java
index c1bef176..a819f897 100644
--- a/src/main/java/com/commafeed/backend/model/ApplicationSettings.java
+++ b/src/main/java/com/commafeed/backend/model/ApplicationSettings.java
@@ -2,13 +2,22 @@ package com.commafeed.backend.model;
 
 import javax.persistence.Entity;
 import javax.persistence.Table;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
 
 @Entity
 @Table(name = "APPLICATIONSETTINGS")
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class ApplicationSettings extends AbstractModel {
 
 	private String publicUrl;
+
+	/**
+	 * Wether registrations are open
+	 */
 	private boolean allowRegistrations = false;
 	private String googleClientId;
 	private String googleClientSecret;
diff --git a/src/main/java/com/commafeed/frontend/model/Category.java b/src/main/java/com/commafeed/frontend/model/Category.java
index 6cea0a9b..f782a963 100644
--- a/src/main/java/com/commafeed/frontend/model/Category.java
+++ b/src/main/java/com/commafeed/frontend/model/Category.java
@@ -3,9 +3,15 @@ package com.commafeed.frontend.model;
 import java.io.Serializable;
 import java.util.List;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 import com.google.common.collect.Lists;
 
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class Category implements Serializable {
 
 	private String id;
diff --git a/src/main/java/com/commafeed/frontend/model/Entries.java b/src/main/java/com/commafeed/frontend/model/Entries.java
index 52eba7d7..bdbf2f0b 100644
--- a/src/main/java/com/commafeed/frontend/model/Entries.java
+++ b/src/main/java/com/commafeed/frontend/model/Entries.java
@@ -3,9 +3,15 @@ package com.commafeed.frontend.model;
 import java.io.Serializable;
 import java.util.List;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 import com.google.common.collect.Lists;
 
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class Entries implements Serializable {
 	private String name;
 	private String message;
diff --git a/src/main/java/com/commafeed/frontend/model/Entry.java b/src/main/java/com/commafeed/frontend/model/Entry.java
index ed39aeb4..d750be8c 100644
--- a/src/main/java/com/commafeed/frontend/model/Entry.java
+++ b/src/main/java/com/commafeed/frontend/model/Entry.java
@@ -3,7 +3,13 @@ package com.commafeed.frontend.model;
 import java.io.Serializable;
 import java.util.Date;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class Entry implements Serializable {
 
 	private String id;
diff --git a/src/main/java/com/commafeed/frontend/model/MarkRequest.java b/src/main/java/com/commafeed/frontend/model/MarkRequest.java
index a707c397..622d9be6 100644
--- a/src/main/java/com/commafeed/frontend/model/MarkRequest.java
+++ b/src/main/java/com/commafeed/frontend/model/MarkRequest.java
@@ -2,7 +2,13 @@ package com.commafeed.frontend.model;
 
 import java.io.Serializable;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class MarkRequest implements Serializable {
 	private String type;
 	private String id;
diff --git a/src/main/java/com/commafeed/frontend/model/ProfileModificationRequest.java b/src/main/java/com/commafeed/frontend/model/ProfileModificationRequest.java
index 3ef5788d..4aa1dda7 100644
--- a/src/main/java/com/commafeed/frontend/model/ProfileModificationRequest.java
+++ b/src/main/java/com/commafeed/frontend/model/ProfileModificationRequest.java
@@ -1,5 +1,11 @@
 package com.commafeed.frontend.model;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class ProfileModificationRequest {
 	
 	private String email;
diff --git a/src/main/java/com/commafeed/frontend/model/RegistrationRequest.java b/src/main/java/com/commafeed/frontend/model/RegistrationRequest.java
index 4c95057c..20b9bd08 100644
--- a/src/main/java/com/commafeed/frontend/model/RegistrationRequest.java
+++ b/src/main/java/com/commafeed/frontend/model/RegistrationRequest.java
@@ -2,7 +2,13 @@ package com.commafeed.frontend.model;
 
 import java.io.Serializable;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class RegistrationRequest implements Serializable {
 
 	private String name;
diff --git a/src/main/java/com/commafeed/frontend/model/Settings.java b/src/main/java/com/commafeed/frontend/model/Settings.java
index be13e91e..61b067b4 100644
--- a/src/main/java/com/commafeed/frontend/model/Settings.java
+++ b/src/main/java/com/commafeed/frontend/model/Settings.java
@@ -2,7 +2,13 @@ package com.commafeed.frontend.model;
 
 import java.io.Serializable;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class Settings implements Serializable {
 
 	private String readingMode;
diff --git a/src/main/java/com/commafeed/frontend/model/Subscription.java b/src/main/java/com/commafeed/frontend/model/Subscription.java
index 91c5907b..512e4f08 100644
--- a/src/main/java/com/commafeed/frontend/model/Subscription.java
+++ b/src/main/java/com/commafeed/frontend/model/Subscription.java
@@ -2,7 +2,13 @@ package com.commafeed.frontend.model;
 
 import java.io.Serializable;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class Subscription implements Serializable {
 
 	private Long id;
diff --git a/src/main/java/com/commafeed/frontend/model/SubscriptionRequest.java b/src/main/java/com/commafeed/frontend/model/SubscriptionRequest.java
index 71348c1c..a00ea470 100644
--- a/src/main/java/com/commafeed/frontend/model/SubscriptionRequest.java
+++ b/src/main/java/com/commafeed/frontend/model/SubscriptionRequest.java
@@ -2,7 +2,13 @@ package com.commafeed.frontend.model;
 
 import java.io.Serializable;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class SubscriptionRequest implements Serializable {
 
 	private String url;
diff --git a/src/main/java/com/commafeed/frontend/model/UserModel.java b/src/main/java/com/commafeed/frontend/model/UserModel.java
index 27f044a1..f6b92d7c 100644
--- a/src/main/java/com/commafeed/frontend/model/UserModel.java
+++ b/src/main/java/com/commafeed/frontend/model/UserModel.java
@@ -2,7 +2,13 @@ package com.commafeed.frontend.model;
 
 import java.io.Serializable;
 
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlRootElement;
+
 @SuppressWarnings("serial")
+@XmlRootElement
+@XmlAccessorType(XmlAccessType.FIELD)
 public class UserModel implements Serializable {
 
 	private Long id;
diff --git a/src/main/java/com/commafeed/frontend/rest/resources/AdminSettingsREST.java b/src/main/java/com/commafeed/frontend/rest/resources/AdminSettingsREST.java
index ec6312ee..4bbaf4f8 100644
--- a/src/main/java/com/commafeed/frontend/rest/resources/AdminSettingsREST.java
+++ b/src/main/java/com/commafeed/frontend/rest/resources/AdminSettingsREST.java
@@ -4,7 +4,6 @@ import javax.inject.Inject;
 import javax.ws.rs.GET;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
-import javax.ws.rs.core.Response;
 
 import com.commafeed.backend.model.ApplicationSettings;
 import com.commafeed.backend.model.UserRole.Role;
@@ -26,8 +25,7 @@ public class AdminSettingsREST {
 
 	@Path("save")
 	@POST
-	public Response save(ApplicationSettings settings) {
+	public void save(ApplicationSettings settings) {
 		applicationSettingsService.save(settings);
-		return Response.ok().build();
 	}
 }