From e1f3b8da5478a421c15fa744e3520924cab9f3d9 Mon Sep 17 00:00:00 2001
From: Eike Foken <kontakt@eikefoken.de>
Date: Mon, 15 Aug 2011 23:24:24 +0200
Subject: [PATCH] Documentation in user model and access library

---
 application/libraries/Access.php | 9 +++++++++
 application/models/user.php      | 1 +
 2 files changed, 10 insertions(+)

diff --git a/application/libraries/Access.php b/application/libraries/Access.php
index 55a4e98..8068696 100644
--- a/application/libraries/Access.php
+++ b/application/libraries/Access.php
@@ -48,6 +48,9 @@ class Access {
 	/**
 	 * Changes a users password.
 	 *
+	 * @param string $username
+	 * @param string $old
+	 * @param string $new
 	 * @return boolean
 	 */
 	public function changePassword($username, $old, $new) {
@@ -63,6 +66,7 @@ class Access {
 	/**
 	 * forgotten password feature
 	 *
+	 * @param string $email
 	 * @return void
 	 */
 	public function forgottenPassword($email) {
@@ -101,6 +105,7 @@ class Access {
 	/**
 	 * forgotten_password_complete
 	 *
+	 * @param string $code
 	 * @return void
 	 */
 	public function forgottenPasswordComplete($code) {
@@ -146,6 +151,9 @@ class Access {
 	/**
 	 * Logs the user in.
 	 *
+	 * @param string $username
+	 * @param string $password
+	 * @param boolean $remember
 	 * @return boolean
 	 */
 	public function login($username, $password, $remember = false) {
@@ -204,6 +212,7 @@ class Access {
 	/**
 	 * Checks if the current user is assigned to the specified group.
 	 *
+	 * @param string $checkGroup
 	 * @return boolean
 	 */
 	public function isGroup($checkGroup)  {
diff --git a/application/models/user.php b/application/models/user.php
index 2942dc6..d70574d 100644
--- a/application/models/user.php
+++ b/application/models/user.php
@@ -117,6 +117,7 @@ class User extends CI_Model {
 	/**
 	 * Checks entered usernames.
 	 *
+	 * @param string $username
 	 * @return boolean
 	 */
 	public function checkUsername($username = '') {