Commits

David Carr committed 61b21bd

docs: tweak javadocs for shiro integration

  • Participants
  • Parent commits 2d034a3

Comments (0)

Files changed (3)

shiro-integration/build.gradle

     compile "org.apache.shiro:shiro-core:1.2.1"
     testCompile "org.slf4j:slf4j-simple:1.7.2"
 }
+
+javadoc {
+    title "AuthC4J Shiro Integration ${version}"
+    options.links "http://docs.oracle.com/javase/7/docs/api/", "http://shiro.apache.org/static/current/apidocs/"
+}
+
+uploadArchives.repositories.mavenDeployer {
+    pom {
+        project {
+            name "shiro-integration"
+            description "AuthC4J Shiro Integration"
+        }
+    }
+}

shiro-integration/src/main/java/us/carrclan/david/authc4j/shiro/AuthC4JPrincipal.java

 import java.util.HashSet;
 import java.util.Set;
 
+/**
+ * A principal based on user information from AuthC4J.
+ */
 public class AuthC4JPrincipal implements Serializable {
     private static final long serialVersionUID = 1;
     private final String shortName;

shiro-integration/src/main/java/us/carrclan/david/authc4j/shiro/package-info.java

+/*
+ * Copyright 2013 David M. Carr
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
+ * the License for the specific language governing permissions and limitations under the License.
+ */
+
+/**
+ * An integration between AuthC4J and <a href="http://shiro.apache.org/">Shiro</a>.
+ */
+package us.carrclan.david.authc4j.shiro;