More documentation cleanup.

git-svn-id: https://samskivert.googlecode.com/svn/trunk@1572 6335cc39-0255-0410-8fd6-9bcaacd3b74c
2005-01-14 16:05:19 +00:00
parent 233fc6db0a
commit 4f13eb8571
9 changed files with 177 additions and 4 deletions
@@ -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/">
      <packageset dir="${src.dir}">
        <exclude name="com/samskivert/io/**" unless="build.io"/>
        <exclude name="com/samskivert/jdbc/**" unless="build.jdbc"/>
@@ -0,0 +1,32 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <html>
 <head>
 <!--
  $Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
  samskivert library - useful routines for java programs
  Copyright (C) 2001-2005 Michael Bayne
  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 -->
 </head>
 <body bgcolor="white">
    Various I/O related utilities.
 </body>
 </html>
@@ -26,7 +26,7 @@
 </head>
 <body bgcolor="white">
-    Provides a network related services and patterns.
+    Provides network related services and patterns.
 </body>
 </html>
@@ -92,8 +92,19 @@ public class UserRepository extends JORARepository
    }
    /**
-     * Like {@link #createUser(String,String,String,String,int)} except
+     * Requests that a new user be created in the repository.
-     * that the supplied password has already been encrypted.
+     *
     * @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)
@@ -0,0 +1,32 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <html>
 <head>
 <!--
  $Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
  samskivert library - useful routines for java programs
  Copyright (C) 2001-2005 Michael Bayne
  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 -->
 </head>
 <body bgcolor="white">
    A basic system for handling drag and drop within a single application.
 </body>
 </html>
@@ -0,0 +1,32 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <html>
 <head>
 <!--
  $Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
  samskivert library - useful routines for java programs
  Copyright (C) 2001-2005 Michael Bayne
  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 -->
 </head>
 <body bgcolor="white">
    Swing event adapters and utilities.
 </body>
 </html>
@@ -0,0 +1,32 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <html>
 <head>
 <!--
  $Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
  samskivert library - useful routines for java programs
  Copyright (C) 2001-2005 Michael Bayne
  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 -->
 </head>
 <body bgcolor="white">
    Utilities useful when writing unit tests.
 </body>
 </html>
@@ -0,0 +1,32 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <html>
 <head>
 <!--
  $Id: package.html,v 1.1 2001/08/12 01:34:31 mdb Exp $
  samskivert library - useful routines for java programs
  Copyright (C) 2001-2005 Michael Bayne
  This library is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published
  by the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 -->
 </head>
 <body bgcolor="white">
    Utilities for text processing and i18n.
 </body>
 </html>
@@ -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