Commit 929a312b by pupi1985

PHPDoc update in app/cookies, app/format, app/mailing and app/search

parent 53749f1e
......@@ -27,6 +27,7 @@ if (!defined('QA_VERSION')) { // don't allow this page to be requested directly
/**
* Return the user identification cookie sent by the browser for this page request, or null if none
* @return string|null
*/
function qa_cookie_get()
{
......@@ -39,6 +40,7 @@ function qa_cookie_get()
/**
* Return user identification cookie sent by browser if valid, or create a new one if not.
* Either way, extend for another year (this is used when an anonymous post is created)
* @return string
*/
function qa_cookie_get_create()
{
......@@ -63,8 +65,8 @@ function qa_cookie_get_create()
/**
* Called after a database write $action performed by a user identified by $cookieid,
* relating to $questionid, $answerid and/or $commentid
* @param $cookieid
* @param $action
* @param string $cookieid
* @param string $action
*/
function qa_cookie_report_action($cookieid, $action)
{
......
......@@ -120,10 +120,10 @@ function qa_mailing_perform_step()
/**
* Send a single message from the mailing, to $userid with $handle and $email.
* Pass the user's existing $emailcode if there is one, otherwise a new one will be set up
* @param $userid
* @param $handle
* @param $email
* @param $emailcode
* @param mixed $userid
* @param string $handle
* @param string $email
* @param string $emailcode
* @return bool
*/
function qa_mailing_send_one($userid, $handle, $email, $emailcode)
......@@ -152,6 +152,7 @@ function qa_mailing_send_one($userid, $handle, $email, $emailcode)
/**
* Return a message describing current progress in the mailing
* @return string|null
*/
function qa_mailing_progress_message()
{
......
......@@ -30,13 +30,13 @@ if (!defined('QA_VERSION')) { // don't allow this page to be requested directly
* to get absolute URLs for the results and $fullcontent if the results should include full post content. This calls
* through to the chosen search module, and performs all the necessary post-processing to supplement the results for
* display online or in an RSS feed.
* @param $query
* @param $start
* @param $count
* @param $userid
* @param $absoluteurls
* @param $fullcontent
* @return
* @param string $query
* @param int $start
* @param int $count
* @param mixed $userid
* @param bool $absoluteurls
* @param bool $fullcontent
* @return array
*/
function qa_get_search_results($query, $start, $count, $userid, $absoluteurls, $fullcontent)
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment