Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

PHPDoc fixes

  • Loading branch information...
commit 7b736d2b739b11ba4dbf08793c6dd22912818cbd 1 parent 07c09a0
@jayj authored
View
3  .gitignore
@@ -8,4 +8,5 @@ _notes
dwsync.xml
# Folders to ignore
-.svn
+.svn
+docs/
View
19 functions.php
@@ -21,7 +21,7 @@
*
* @package Cakifo
* @subpackage Functions
- * @version 1.4-dev
+ * @version 1.4.1
* @author Jesper Johansen <kontakt@jayj.dk>
* @copyright Copyright (c) 2011-2012, Jesper Johansen
* @link http://wpthemes.jayj.dk/cakifo
@@ -309,7 +309,7 @@ function cakifo_front_page() {
/**
* Add the javascript needed for the slider
*
- * @uses apply_filters( 'cakifo_flexslider_args', $args ) Allows you to change the default values.
+ * @uses apply_filters() The cakifo_flexslider_args filter allows you to change the default values.
* @since Cakifo 1.0
*/
function cakifo_slider_javascript() {
@@ -505,10 +505,10 @@ function cakifo_image_entry_meta( $meta ) {
*
* No longer showed by default in version 1.3
* If you still want it, use this in your child theme:
- * <code>
- * remove_action( "{$prefix}_close_menu_primary", 'get_search_form' );
- * add_action( "{$prefix}_close_menu_primary", 'cakifo_topbar_rss' );
- * </code>
+ * <code>
+ * remove_action( "{$prefix}_close_menu_primary", 'get_search_form' );
+ * add_action( "{$prefix}_close_menu_primary", 'cakifo_topbar_rss' );
+ * </code>
*
* @return string The RSS feed and maybe a Twitter link
* @since Cakifo 1.0
@@ -581,6 +581,10 @@ function cakifo_disable_sidebars( $sidebars_widgets ) {
* expand the full width on video pages. This function overwrites what the $content_width variable handles
* with context-based widths.
*
+ * @uses hybrid_get_content_width()
+ * @uses hybrid_set_content_width()
+ * @uses theme_layouts_get_layout()
+ * @param array $args Array with default embed settings
* @since Cakifo 1.3
*/
function cakifo_content_width( $args ) {
@@ -948,7 +952,7 @@ function cakifo_get_image_size( $name ) {
*
* It will either match all text containing http:// or https://
* If the first argument passed gets changed to 'href',
- * it will only match links from anchor links (<code><a href="http://..."></a></code>)
+ * it will only match links from anchor links
*
* @param string $type http or href. Default is http
* @param string $content The content to search for URLs in. Default is the post content.
@@ -980,6 +984,7 @@ function cakifo_url_grabber( $type = 'http', $content = null ) {
/**
* @since Cakifo 1.0
* @deprecated Cakifo 1.3 Use the native WordPress function wp_trim_words() instead.
+ * @ignore
*/
function cakifo_the_excerpt( $length = 55, $echo = true ) {
_deprecated_function( __FUNCTION__, '1.3', 'wp_trim_words()' );
View
2  functions/sidebars.php
@@ -224,7 +224,7 @@ function cakifo_register_widgets() {
* Otherwise the plugin results in error because Hybrid Core
* deregister default WordPress widgets
*
- * @link (http://wordpress.org/extend/plugins/monster-widget/, Monster Widgets)
+ * @link http://wordpress.org/extend/plugins/monster-widget/ Monster Widgets
* @since Cakifo 1.4
*/
function cakifo_monster_widgets() {
View
17 functions/widget-related-posts.php
@@ -11,12 +11,6 @@
* @link http://wpthemes.jayj.dk/cakifo
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU General Public License, v2 (or newer)
*/
-
-/**
- * Related Posts widget class.
- *
- * @since Cakifo 1.3
- */
class Cakifo_Widget_Related_Posts extends WP_Widget {
/**
@@ -46,9 +40,12 @@ function __construct() {
/**
* Outputs the widget based on the arguments input through the widget controls.
*
+ * @param array $sidebar
+ * @param array $instance
* @since Cakifo 1.3
*/
function widget( $sidebar, $instance ) {
+
extract( $sidebar );
$post_id = get_the_ID();
@@ -140,8 +137,10 @@ function widget( $sidebar, $instance ) {
* Gets the related posts based on the category and post format
* and puts them in a custom field
*
- * @since Cakifo 1.3
* @access private
+ * @param int $post_id
+ * @param array $args
+ * @since Cakifo 1.3
*/
private function _get_related_posts( $post_id, $args ) {
@@ -220,6 +219,8 @@ private function _get_related_posts( $post_id, $args ) {
/**
* Updates the widget control options for the particular instance of the widget.
*
+ * @param array $new_instance The new setting
+ * @param array $old_instance The old setting
* @since Cakifo 1.3
*/
function update( $new_instance, $old_instance ) {
@@ -240,6 +241,7 @@ function update( $new_instance, $old_instance ) {
/**
* Flush the related posts meta when a post is updated, deleted or the settings has been changed
*
+ * @param int|null $post_ID
* @since Cakifo 1.3
*/
function flush_widget_cache( $post_ID = null ) {
@@ -271,6 +273,7 @@ function flush_widget_cache( $post_ID = null ) {
/**
* Displays the widget control options in the Widgets admin screen.
*
+ * @param array $instance The widget settings in the database
* @since Cakifo 1.3
*/
function form( $instance ) {
Please sign in to comment.
Something went wrong with that request. Please try again.