Commit a1a4cba6 by Scott

Remove unnecessary DocBlock tags

parent ca7f53d4
...@@ -65,7 +65,6 @@ class qa_html_theme_layer extends qa_html_theme_base ...@@ -65,7 +65,6 @@ class qa_html_theme_layer extends qa_html_theme_base
* Returns the needed HTML to display the tip. Depending on the theme in use, this might need to be * Returns the needed HTML to display the tip. Depending on the theme in use, this might need to be
* tuned in order for the tip to be displayed properly * tuned in order for the tip to be displayed properly
* *
* @access private
* @param string $mouseOverText Text of the tip * @param string $mouseOverText Text of the tip
* @param string $questionTitle Question title * @param string $questionTitle Question title
* @return string HTML needed to display the tip and the question title * @return string HTML needed to display the tip and the question title
......
...@@ -44,7 +44,7 @@ abstract class AbstractStep ...@@ -44,7 +44,7 @@ abstract class AbstractStep
/** /**
* Return the translated language ID string replacing the progress and total in it. * Return the translated language ID string replacing the progress and total in it.
* @access private *
* @param string $langId Language string ID that contains 2 placeholders (^1 and ^2) * @param string $langId Language string ID that contains 2 placeholders (^1 and ^2)
* @param int $progress Amount of processed elements * @param int $progress Amount of processed elements
* @param int $total Total amount of elements * @param int $total Total amount of elements
......
...@@ -19,15 +19,8 @@ ...@@ -19,15 +19,8 @@
*/ */
/** /**
* Snow theme extends * Snow theme HTML customizations
* *
* Extends the core theme class <code>qa_html_theme_base</code>
*
* @package qa_html_theme_base
* @subpackage qa_html_theme
* @category Theme
* @since Snow 1.0
* @version 1.4
* @author Q2A Market <http://www.q2amarket.com> * @author Q2A Market <http://www.q2amarket.com>
* @copyright (c) 2014, Q2A Market * @copyright (c) 2014, Q2A Market
* @license http://www.gnu.org/copyleft/gpl.html * @license http://www.gnu.org/copyleft/gpl.html
...@@ -54,8 +47,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -54,8 +47,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Adding aditional meta for responsive design * Adding aditional meta for responsive design
*
* @since Snow 1.4
*/ */
public function head_metas() public function head_metas()
{ {
...@@ -65,8 +56,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -65,8 +56,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Adding theme stylesheets * Adding theme stylesheets
*
* @since Snow 1.4
*/ */
public function head_css() public function head_css()
{ {
...@@ -110,8 +99,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -110,8 +99,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Adding theme javascripts * Adding theme javascripts
*
* @since Snow 1.4
*/ */
public function head_script() public function head_script()
{ {
...@@ -123,8 +110,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -123,8 +110,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Adding point count for logged in user * Adding point count for logged in user
*
* @since Snow 1.4
*/ */
public function logged_in() public function logged_in()
{ {
...@@ -141,8 +126,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -141,8 +126,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Adding body class dynamically. Override needed to add class on admin/approve-users page * Adding body class dynamically. Override needed to add class on admin/approve-users page
*
* @since Snow 1.4
*/ */
public function body_tags() public function body_tags()
{ {
...@@ -167,8 +150,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -167,8 +150,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Login form for user dropdown menu. * Login form for user dropdown menu.
*
* @since Snow 1.4
*/ */
public function nav_user_search() public function nav_user_search()
{ {
...@@ -207,8 +188,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -207,8 +188,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Modify markup for topbar. * Modify markup for topbar.
*
* @since Snow 1.4
*/ */
public function nav_main_sub() public function nav_main_sub()
{ {
...@@ -223,8 +202,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -223,8 +202,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Remove the '-' from the note for the category page (notes). * Remove the '-' from the note for the category page (notes).
*
* @since Snow 1.4
* @param array $navlink * @param array $navlink
* @param string $class * @param string $class
*/ */
...@@ -243,8 +220,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -243,8 +220,6 @@ class qa_html_theme extends qa_html_theme_base
* - Swaps the <tt>main()</tt> and <tt>sidepanel()</tt> functions * - Swaps the <tt>main()</tt> and <tt>sidepanel()</tt> functions
* - Moves the header and footer functions outside qa-body-wrapper * - Moves the header and footer functions outside qa-body-wrapper
* - Keeps top/high and low/bottom widgets separated * - Keeps top/high and low/bottom widgets separated
*
* @since Snow 1.4
*/ */
public function body_content() public function body_content()
{ {
...@@ -272,8 +247,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -272,8 +247,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Header in full width top bar * Header in full width top bar
*
* @since Snow 1.4
*/ */
public function header() public function header()
{ {
...@@ -290,8 +263,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -290,8 +263,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Footer in full width bottom bar * Footer in full width bottom bar
*
* @since Snow 1.4
*/ */
public function footer() public function footer()
{ {
...@@ -306,9 +277,21 @@ class qa_html_theme extends qa_html_theme_base ...@@ -306,9 +277,21 @@ class qa_html_theme extends qa_html_theme_base
} }
/** /**
* Adds placeholder "Search..." for search box
*/
public function search_field($search)
{
$this->output(
sprintf('<input type="text" placeholder="%s..." %s value="%s" class="qa-search-field"/>',
$search['button_label'],
$search['field_tags'],
isset($search['value']) ? $search['value'] : ''
)
);
}
/**
* Overridden to customize layout and styling * Overridden to customize layout and styling
*
* @since Snow 1.4
*/ */
public function sidepanel() public function sidepanel()
{ {
...@@ -332,8 +315,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -332,8 +315,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Allow alternate sidebar color. * Allow alternate sidebar color.
*
* @since Snow 1.4
*/ */
public function sidebar() public function sidebar()
{ {
...@@ -349,8 +330,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -349,8 +330,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Add close icon * Add close icon
*
* @since Snow 1.4
* @param array $q_item * @param array $q_item
*/ */
public function q_item_title($q_item) public function q_item_title($q_item)
...@@ -386,8 +365,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -386,8 +365,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Add closed icon for closed questions * Add closed icon for closed questions
*
* @since Snow 1.4
*/ */
public function title() public function title()
{ {
...@@ -414,8 +391,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -414,8 +391,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Add view counter to question list * Add view counter to question list
*
* @since Snow 1.4
* @param array $q_item * @param array $q_item
*/ */
public function q_item_stats($q_item) public function q_item_stats($q_item)
...@@ -431,8 +406,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -431,8 +406,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Prevent display view counter on usual place * Prevent display view counter on usual place
*
* @since Snow 1.4
* @param array $q_item * @param array $q_item
*/ */
public function view_count($q_item) public function view_count($q_item)
...@@ -442,8 +415,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -442,8 +415,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Add view counter to question view * Add view counter to question view
*
* @since Snow 1.4
* @param array $q_view * @param array $q_view
*/ */
public function q_view_stats($q_view) public function q_view_stats($q_view)
...@@ -459,8 +430,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -459,8 +430,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Modify user whometa, move to top * Modify user whometa, move to top
*
* @since Snow 1.4
* @param array $q_view * @param array $q_view
*/ */
public function q_view_main($q_view) public function q_view_main($q_view)
...@@ -507,8 +476,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -507,8 +476,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Move user whometa to top in answer * Move user whometa to top in answer
*
* @since Snow 1.4
* @param array $a_item * @param array $a_item
*/ */
public function a_item_main($a_item) public function a_item_main($a_item)
...@@ -566,8 +533,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -566,8 +533,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Move user whometa to top in comment, add comment voting back in * Move user whometa to top in comment, add comment voting back in
*
* @since Snow 1.4
* @param array $c_item * @param array $c_item
*/ */
public function c_item_main($c_item) public function c_item_main($c_item)
...@@ -612,8 +577,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -612,8 +577,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Q2A Market attribution. * Q2A Market attribution.
* I'd really appreciate you displaying this link on your Q2A site. Thank you - Jatin * I'd really appreciate you displaying this link on your Q2A site. Thank you - Jatin
*
* @since Snow 1.4
*/ */
public function attribution() public function attribution()
{ {
...@@ -630,8 +593,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -630,8 +593,6 @@ class qa_html_theme extends qa_html_theme_base
* User account navigation item. This will return based on login information. * User account navigation item. This will return based on login information.
* If user is logged in, it will populate user avatar and account links. * If user is logged in, it will populate user avatar and account links.
* If user is guest, it will populate login form and registration link. * If user is guest, it will populate login form and registration link.
*
* @since Snow 1.4
*/ */
private function qam_user_account() private function qam_user_account()
{ {
...@@ -678,9 +639,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -678,9 +639,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Add search-box wrapper with extra class for color scheme * Add search-box wrapper with extra class for color scheme
*
* @since Snow 1.4
* @version 1.0
* @param string $addon_class * @param string $addon_class
* @param string $ids * @param string $ids
*/ */
...@@ -695,10 +653,7 @@ class qa_html_theme extends qa_html_theme_base ...@@ -695,10 +653,7 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Dynamic <code>CSS</code> based on options and other interaction with Q2A. * Dynamic CSS based on options and other interaction with Q2A.
*
* @since Snow 1.4
* @version 1.0
* @return string The CSS code * @return string The CSS code
*/ */
private function head_inline_css() private function head_inline_css()
...@@ -725,10 +680,6 @@ class qa_html_theme extends qa_html_theme_base ...@@ -725,10 +680,6 @@ class qa_html_theme extends qa_html_theme_base
/** /**
* Custom ask button for medium and small screen * Custom ask button for medium and small screen
*
* @access private
* @since Snow 1.4
* @version 1.0
* @return string Ask button html markup * @return string Ask button html markup
*/ */
private function ask_button() private function ask_button()
...@@ -744,20 +695,4 @@ class qa_html_theme extends qa_html_theme_base ...@@ -744,20 +695,4 @@ class qa_html_theme extends qa_html_theme_base
'</div>' . '</div>' .
'</div>'; '</div>';
} }
/**
* Adds placeholder "Search..." for search box
*
* @since Snow 1.4
*/
public function search_field($search)
{
$this->output(
sprintf('<input type="text" placeholder="%s..." %s value="%s" class="qa-search-field"/>',
$search['button_label'],
$search['field_tags'],
isset($search['value']) ? $search['value'] : ''
)
);
}
} }
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