Skip to content

Commit

Permalink
Completion and fixes for wp-app, wp-login and xmlrpc inline documenta…
Browse files Browse the repository at this point in the history
…tion, props jacobsantos, fixes #7550

git-svn-id: http://svn.automattic.com/wordpress/trunk@8952 1a063a9b-81f0-0310-95a4-ce76da25c4cd
  • Loading branch information
azaozz committed Sep 22, 2008
1 parent 509904e commit eb3e916
Show file tree
Hide file tree
Showing 3 changed files with 497 additions and 124 deletions.
10 changes: 5 additions & 5 deletions wp-app.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,14 @@ function log_app($label,$msg) {

if ( !function_exists('wp_set_current_user') ) :
/**
* wp_set_current_user() - Sets the current WordPress User
* Sets the current WordPress User.
*
* Pluggable function which is also found in pluggable.php.
*
* @see wp-includes/pluggable.php Documentation for this function.
* @uses $current_user Global of current user to test whether $id is the same.
*
* @param int $id The user's ID
* @param int $id The user's ID.
* @param string $name Optional. The username of the user.
* @return WP_User Current user's User object
*/
Expand All @@ -91,7 +91,7 @@ function wp_set_current_user($id, $name = '') {
endif;

/**
* wa_posts_where_include_drafts_filter() - Filter to add more post statuses
* Filter to add more post statuses.
*
* @param string $where SQL statement to filter
* @return string Filtered SQL statement with added post_status for where clause
Expand All @@ -104,11 +104,11 @@ function wa_posts_where_include_drafts_filter($where) {
add_filter('posts_where', 'wa_posts_where_include_drafts_filter');

/**
* @internal
* Left undocumented to work on later. If you want to finish, then please do so.
* WordPress AtomPub API implementation.
*
* @package WordPress
* @subpackage Publishing
* @since 2.2.0
*/
class AtomServer {

Expand Down
15 changes: 4 additions & 11 deletions wp-login.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@
}

/**
* login_header() - Outputs the header for the login page
* Outputs the header for the login page.
*
* @package WordPress
* @uses do_action() Calls the 'login_head' for outputting HTML in the Login
* header.
* @uses apply_filters() Calls 'login_headerurl' for the top login link.
Expand Down Expand Up @@ -87,9 +86,7 @@ function login_header($title = 'Login', $message = '', $wp_error = '') {
} // End of login_header()

/**
* retrieve_password() - Handles sending password retrieval email to user
*
* {@internal Missing Long Description}}
* Handles sending password retrieval email to user.
*
* @uses $wpdb WordPress Database object
*
Expand Down Expand Up @@ -157,9 +154,7 @@ function retrieve_password() {
}

/**
* reset_password() - Handles resetting the user's password
*
* {@internal Missing Long Description}}
* Handles resetting the user's password.
*
* @uses $wpdb WordPress Database object
*
Expand Down Expand Up @@ -196,9 +191,7 @@ function reset_password($key) {
}

/**
* register_new_user() - Handles registering a new user
*
* {@internal Missing Long Description}}
* Handles registering a new user.
*
* @param string $user_login User's username for logging in
* @param string $user_email User's email address to send password and add
Expand Down
Loading

0 comments on commit eb3e916

Please sign in to comment.