Welcome Guest, Not a member yet? Register   Sign In
How to use phpdoc correctly in this case
#1

[eluser]Slowcheetah[/eluser]
The model below gets 2 input parameters, 1 string (id) and 1 array (account_data) and returns a bool (true or false). Is this the most efficient method, and is my phpdoc header formatted correctly?

Code:
/**
     * function update_profile($id, $account_data)
     *
     * Updates profile database
     * @version 0.1
     * @param $id - string, $account_data - array
     * @return Bool - TRUE or FALSE
     */
    
    function update_profile($id, $account_data) {
        $this->db->where('id', $id);
        $this->db->update('profiles', $account_data);
        
        if ($this->db->affected_rows() == '1') {
            return TRUE;
        }
        
        return FALSE;
    }


Messages In This Thread
How to use phpdoc correctly in this case - by El Forum - 07-27-2009, 08:18 AM
How to use phpdoc correctly in this case - by El Forum - 07-27-2009, 10:57 AM
How to use phpdoc correctly in this case - by El Forum - 07-30-2009, 08:48 AM
How to use phpdoc correctly in this case - by El Forum - 07-30-2009, 09:07 AM



Theme © iAndrew 2016 - Forum software by © MyBB