Browse files

Inline PHP doc updates.

git-svn-id: http://svn.locallylost.com/themes/hybrid-core/trunk@964 dba0f204-706d-4bc1-bc29-8b92e0485636
  • Loading branch information...
1 parent 10018e2 commit 14a8f7c2a2e3d46ec9bc3274b6c4ea64310067ce greenshady committed Dec 16, 2011
Showing with 8 additions and 3 deletions.
  1. +3 −1 extensions/post-stylesheets.php
  2. +5 −2 extensions/theme-layouts.php
View
4 extensions/post-stylesheets.php
@@ -157,7 +157,7 @@ function post_stylesheets_stylesheet_uri( $stylesheet_uri, $stylesheet_dir_uri )
* @since 0.3.0
* @access public
* @param int $post_id The ID of the post to get the stylesheet for.
- * @return string|bool Stylesheet name if given. False for no stylesheet.
+ * @return string Stylesheet name if given. Empty string for no stylesheet.
*/
function get_post_stylesheet( $post_id ) {
return get_post_meta( $post_id, post_stylesheets_get_meta_key(), true );
@@ -170,6 +170,7 @@ function get_post_stylesheet( $post_id ) {
* @access public
* @param int $post_id The ID of the post to set the stylesheet for.
* @param string $stylesheet The filename of the stylesheet.
+ * @return bool True on successful update, false on failure.
*/
function set_post_stylesheet( $post_id, $stylesheet ) {
return update_post_meta( $post_id, post_stylesheets_get_meta_key(), $stylesheet );
@@ -181,6 +182,7 @@ function set_post_stylesheet( $post_id, $stylesheet ) {
* @since 0.3.0
* @access public
* @param int $post_id The ID of the post to delete the stylesheet for.
+ * @return bool True on successful delete, false on failure.
*/
function delete_post_stylesheet( $post_id ) {
return delete_post_meta( $post_id, post_stylesheets_get_meta_key() );
View
7 extensions/theme-layouts.php
@@ -168,7 +168,7 @@ function get_post_layout( $post_id ) {
* @since 0.2.0
* @param int $post_id The ID of the post to set the layout for.
* @param string $layout The name of the layout to set.
- * @return bool The return value of the update_post_meta() function.
+ * @return bool True on successful update, false on failure.
*/
function set_post_layout( $post_id, $layout ) {
return update_post_meta( $post_id, theme_layouts_get_meta_key(), $layout );
@@ -180,6 +180,7 @@ function set_post_layout( $post_id, $layout ) {
* @since 0.4.0
* @access public
* @param int $post_id The ID of the post to delete the layout for.
+ * @return bool True on successful delete, false on failure.
*/
function delete_post_layout( $post_id ) {
return delete_post_meta( $post_id, theme_layouts_get_meta_key() );
@@ -208,6 +209,7 @@ function has_post_layout( $layout, $post_id = '' ) {
*
* @since 0.3.0
* @param int $user_id The ID of the user to get the layout for.
+ * @return string The layout if one exists, 'default' if one doesn't.
*/
function get_user_layout( $user_id ) {
@@ -224,7 +226,7 @@ function get_user_layout( $user_id ) {
* @since 0.3.0
* @param int $user_id The ID of the user to set the layout for.
* @param string $layout The name of the layout to set.
- * @return bool The return value of update_user_meta() function.
+ * @return bool True on successful update, false on failure.
*/
function set_user_layout( $user_id, $layout ) {
return update_user_meta( $user_id, theme_layouts_get_meta_key(), $layout );
@@ -236,6 +238,7 @@ function set_user_layout( $user_id, $layout ) {
* @since 0.4.0
* @access public
* @param int $user_id The ID of the user to delete the layout for.
+ * @return bool True on successful delete, false on failure.
*/
function delete_user_layout( $user_id ) {
return delete_user_meta( $user_id, theme_layouts_get_meta_key() );

0 comments on commit 14a8f7c

Please sign in to comment.