Changeset 198 for trunk/grails-app/services

Timestamp:

Nov 27, 2009, 1:54:05 PM (15 years ago)

Author:

gav

Message:

Some commenting to PersonService.

File:

• trunk/grails-app/services/PersonService.groovy (modified) (3 diffs)

trunk/grails-app/services/PersonService.groovy

@@ -1 @@
-/* Provides a service class with some methods that integrate the Person domain class and Acegi security.
+/**
+ * Provides a service class with some methods that integrate the Person domain class and Acegi security.
  *
  */
@@ -8 +9 @@
     def authenticateService
 
-    // Get current user as a Person and in a safe way to avoid a null userDomain during bootstrap.
+    /**
+    * Get the current user in a safe way to avoid a null userDomain.
+    * @returns The current user or the 'system' person (Person #1) if userDomain() is not active.
+    */
     def currentUser() {
         if(authenticateService.userDomain()) {
@@ -14 +18 @@
         }
         else {
-            //println "Warning: userDomain not active yet, attempting to return Person #1"
+            log.warn "userDomain not active, attempting to return Person #1."
             return Person.get(1)
         }
     }
 
-    // Convenience wrapper.
+    /**
+    * Convenience wrapper around authenticateService.encodePassword().
+    * @param passClearText The clear text password to encode.
+    * @returns The encoded password.
+    */
     def encodePassword(passClearText) {
         authenticateService.encodePassword(passClearText)