Browse files

Documentation updates part 2.

  • Loading branch information...
1 parent d380d3e commit 380de522257876bf28d592539f471c1021988fed @mfields committed Jan 24, 2011
Showing with 12 additions and 3 deletions.
  1. +12 −3 functions-private.php
View
15 functions-private.php
@@ -24,10 +24,19 @@
*/
/**
- * Remove empty heading tag from the calendar widget.
+ * Calendar Widget Title
*
- * @param array Classes for the body tag.
- * @return array Modified classes for the body tag.
+ * For some reason, WordPress will print a non-breaking space
+ * entity wrapped in the appropriate tags for the calendar
+ * widget even if the title's value is left empty by the user.
+ * This function will remove the empty heading tag.
+ *
+ * Note: empty values are IMPORTANT! in parameters.
+ *
+ * @param string The value of the calendar widget's title for this instance.
+ * @param n/a n/a
+ * @param n/a n/a
+ * @return string Calendar widget title.
*
* @access private
* @since 1.0

0 comments on commit 380de52

Please sign in to comment.