From 4f13eb8571e5421c4dfc4d663c5ffb5a0105bea0 Mon Sep 17 00:00:00 2001 From: mdb Date: Fri, 14 Jan 2005 16:05:19 +0000 Subject: [PATCH] More documentation cleanup. git-svn-id: https://samskivert.googlecode.com/svn/trunk@1572 6335cc39-0255-0410-8fd6-9bcaacd3b74c --- projects/samskivert/build.xml | 2 +- .../src/java/com/samskivert/io/package.html | 32 +++++++++++++++++++ .../src/java/com/samskivert/net/package.html | 2 +- .../servlet/user/UserRepository.java | 15 +++++++-- .../com/samskivert/swing/dnd/package.html | 32 +++++++++++++++++++ .../com/samskivert/swing/event/package.html | 32 +++++++++++++++++++ .../src/java/com/samskivert/test/package.html | 32 +++++++++++++++++++ .../src/java/com/samskivert/text/package.html | 32 +++++++++++++++++++ .../java/com/samskivert/velocity/Logic.java | 2 ++ 9 files changed, 177 insertions(+), 4 deletions(-) create mode 100644 projects/samskivert/src/java/com/samskivert/io/package.html create mode 100644 projects/samskivert/src/java/com/samskivert/swing/dnd/package.html create mode 100644 projects/samskivert/src/java/com/samskivert/swing/event/package.html create mode 100644 projects/samskivert/src/java/com/samskivert/test/package.html create mode 100644 projects/samskivert/src/java/com/samskivert/text/package.html diff --git a/projects/samskivert/build.xml b/projects/samskivert/build.xml index 39032548..d6b433b2 100644 --- a/projects/samskivert/build.xml +++ b/projects/samskivert/build.xml @@ -188,7 +188,7 @@ overview="${src.dir}/${doc.overview}" destdir="${javadoc.dir}" additionalparam="-breakiterator" - link="http://dev.threerings.net/devel/docs/samskivert/"> + link="http://samskivert.com/code/samskivert/samskivert/docs/api/"> diff --git a/projects/samskivert/src/java/com/samskivert/io/package.html b/projects/samskivert/src/java/com/samskivert/io/package.html new file mode 100644 index 00000000..e4a98cb1 --- /dev/null +++ b/projects/samskivert/src/java/com/samskivert/io/package.html @@ -0,0 +1,32 @@ + + + + + + + + Various I/O related utilities. + + + diff --git a/projects/samskivert/src/java/com/samskivert/net/package.html b/projects/samskivert/src/java/com/samskivert/net/package.html index f24ca631..377c057c 100644 --- a/projects/samskivert/src/java/com/samskivert/net/package.html +++ b/projects/samskivert/src/java/com/samskivert/net/package.html @@ -26,7 +26,7 @@ - Provides a network related services and patterns. + Provides network related services and patterns. diff --git a/projects/samskivert/src/java/com/samskivert/servlet/user/UserRepository.java b/projects/samskivert/src/java/com/samskivert/servlet/user/UserRepository.java index ddf2763e..c6ef5dd2 100644 --- a/projects/samskivert/src/java/com/samskivert/servlet/user/UserRepository.java +++ b/projects/samskivert/src/java/com/samskivert/servlet/user/UserRepository.java @@ -92,8 +92,19 @@ public class UserRepository extends JORARepository } /** - * Like {@link #createUser(String,String,String,String,int)} except - * that the supplied password has already been encrypted. + * Requests that a new user be created in the repository. + * + * @param username the username of the new user to create. + * @param password the password for the new user. + * @param realname the user's real name. + * @param email the user's email address. + * @param siteId the unique identifier of the site through which this + * account is being created. The resulting user will be tracked as + * originating from this site for accounting purposes ({@link + * SiteIdentifier#DEFAULT_SITE_ID} can be used by systems that don't + * desire to perform site tracking. + * + * @return The userid of the newly created user. */ public int createUser (Username username, Password password, String realname, String email, int siteId) diff --git a/projects/samskivert/src/java/com/samskivert/swing/dnd/package.html b/projects/samskivert/src/java/com/samskivert/swing/dnd/package.html new file mode 100644 index 00000000..9aeb4036 --- /dev/null +++ b/projects/samskivert/src/java/com/samskivert/swing/dnd/package.html @@ -0,0 +1,32 @@ + + + + + + + + A basic system for handling drag and drop within a single application. + + + diff --git a/projects/samskivert/src/java/com/samskivert/swing/event/package.html b/projects/samskivert/src/java/com/samskivert/swing/event/package.html new file mode 100644 index 00000000..3725d49e --- /dev/null +++ b/projects/samskivert/src/java/com/samskivert/swing/event/package.html @@ -0,0 +1,32 @@ + + + + + + + + Swing event adapters and utilities. + + + diff --git a/projects/samskivert/src/java/com/samskivert/test/package.html b/projects/samskivert/src/java/com/samskivert/test/package.html new file mode 100644 index 00000000..a621f259 --- /dev/null +++ b/projects/samskivert/src/java/com/samskivert/test/package.html @@ -0,0 +1,32 @@ + + + + + + + + Utilities useful when writing unit tests. + + + diff --git a/projects/samskivert/src/java/com/samskivert/text/package.html b/projects/samskivert/src/java/com/samskivert/text/package.html new file mode 100644 index 00000000..6123145c --- /dev/null +++ b/projects/samskivert/src/java/com/samskivert/text/package.html @@ -0,0 +1,32 @@ + + + + + + + + Utilities for text processing and i18n. + + + diff --git a/projects/samskivert/src/java/com/samskivert/velocity/Logic.java b/projects/samskivert/src/java/com/samskivert/velocity/Logic.java index 1f589464..c4578c7a 100644 --- a/projects/samskivert/src/java/com/samskivert/velocity/Logic.java +++ b/projects/samskivert/src/java/com/samskivert/velocity/Logic.java @@ -20,6 +20,8 @@ package com.samskivert.velocity; +import com.samskivert.servlet.util.ExceptionMap; + /** * The logic class is called upon to populate the WebMacro web context, * prior to invoking a particular WebMacro template upon it to generate a