Permalink
Browse files

phpdoc for wp-admin. See #7496 props santosj.

git-svn-id: http://svn.automattic.com/wordpress/trunk@8645 1a063a9b-81f0-0310-95a4-ce76da25c4cd
  • Loading branch information...
westi
westi committed Aug 14, 2008
1 parent 1ef0029 commit 7f894ae41642ca6b8b39764bb7f3312808f44eef
Showing with 1,042 additions and 182 deletions.
  1. +6 −0 wp-admin/admin-header.php
  2. +42 −5 wp-admin/import/blogger.php
  3. +16 −3 wp-admin/import/blogware.php
  4. +15 −1 wp-admin/import/btt.php
  5. +93 −5 wp-admin/import/dotclear.php
  6. +15 −1 wp-admin/import/greymatter.php
  7. +14 −1 wp-admin/import/jkw.php
  8. +14 −1 wp-admin/import/livejournal.php
  9. +14 −1 wp-admin/import/mt.php
  10. +16 −1 wp-admin/import/rss.php
  11. +14 −0 wp-admin/import/stp.php
  12. +29 −4 wp-admin/import/textpattern.php
  13. +14 −1 wp-admin/import/utw.php
  14. +22 −1 wp-admin/import/wordpress.php
  15. +15 −1 wp-admin/import/wp-cat2tag.php
  16. +15 −0 wp-admin/includes/class-ftp-pure.php
  17. +14 −0 wp-admin/includes/class-ftp-sockets.php
  18. +62 −1 wp-admin/includes/class-ftp.php
  19. +57 −48 wp-admin/includes/class-pclzip.php
  20. +14 −1 wp-admin/includes/class-wp-filesystem-base.php
  21. +14 −0 wp-admin/includes/class-wp-filesystem-direct.php
  22. +16 −1 wp-admin/includes/class-wp-filesystem-ftpext.php
  23. +22 −6 wp-admin/includes/class-wp-filesystem-ftpsockets.php
  24. +14 −0 wp-admin/includes/comment.php
  25. +53 −0 wp-admin/includes/update-core.php
  26. +142 −77 wp-admin/install-helper.php
  27. +25 −1 wp-admin/install.php
  28. +8 −0 wp-admin/link-add.php
  29. +12 −1 wp-admin/link-category.php
  30. +11 −3 wp-admin/link-import.php
  31. +8 −1 wp-admin/link-manager.php
  32. +36 −6 wp-admin/link-parse-opml.php
  33. +11 −0 wp-admin/link.php
  34. +12 −1 wp-admin/media-upload.php
  35. +8 −1 wp-admin/media.php
  36. +14 −0 wp-admin/menu-header.php
  37. +19 −5 wp-admin/menu.php
  38. +8 −0 wp-admin/moderation.php
  39. +13 −1 wp-admin/options-head.php
  40. +8 −0 wp-admin/options-privacy.php
  41. +8 −0 wp-admin/post-new.php
  42. +15 −0 wp-admin/profile.php
  43. +24 −1 wp-admin/setup-config.php
  44. +16 −0 wp-admin/update-links.php
  45. +9 −1 wp-admin/upgrade-functions.php
  46. +15 −0 wp-admin/upgrade.php
@@ -18,6 +18,12 @@
$the_current_page = preg_replace('|^.*/wp-admin/|i', '', $_SERVER['PHP_SELF']);
$ie6_no_scrollbar = true;
+/**
+ * Append 'minwidth' to value.
+ *
+ * @param mixed $c
+ * @return string
+ */
function add_minwidth($c) {
return $c . 'minwidth ';
}
@@ -1,9 +1,46 @@
<?php
-
-define( 'MAX_RESULTS', 50 ); // How many records per GData query
-define( 'MAX_EXECUTION_TIME', 20 ); // How many seconds to let the script run
-define( 'STATUS_INTERVAL', 3 ); // How many seconds between status bar updates
-
+/**
+ * Blogger Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ */
+
+/**
+ * How many records per GData query
+ *
+ * @package WordPress
+ * @subpackage Blogger_Import
+ * @var int
+ * @since unknown
+ */
+define( 'MAX_RESULTS', 50 );
+
+/**
+ * How many seconds to let the script run
+ *
+ * @package WordPress
+ * @subpackage Blogger_Import
+ * @var int
+ * @since unknown
+ */
+define( 'MAX_EXECUTION_TIME', 20 );
+
+/**
+ * How many seconds between status bar updates
+ *
+ * @package WordPress
+ * @subpackage Blogger_Import
+ * @var int
+ * @since unknown
+ */
+define( 'STATUS_INTERVAL', 3 );
+
+/**
+ * Blogger Importer class
+ *
+ * @since unknown
+ */
class Blogger_Import {
// Shows the welcome screen and the magic auth link.
@@ -1,7 +1,20 @@
<?php
-
-/* By Shayne Sweeney - http://www.theshayne.com/ */
-
+/**
+ * Blogware XML Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ * @author Shayne Sweeney
+ * @link http://www.theshayne.com/
+ */
+
+/**
+ * Blogware XML Importer class
+ *
+ * Extract posts from Blogware XML export file into your blog.
+ *
+ * @since unknown
+ */
class BW_Import {
var $file;
View
@@ -1,5 +1,19 @@
<?php
-
+/**
+ * BunnyTags Plugin Tag Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ */
+
+/**
+ * BunnyTags Plugin tag converter
+ *
+ * This will process the BunnyTags plugin tags and convert them to the WordPress
+ * 2.3 taxonomy.
+ *
+ * @since unknown
+ */
class BunnyTags_Import {
function header() {
@@ -1,7 +1,11 @@
<?php
-/*
- * DotClear import plugin
- * by Thomas Quinot - http://thomas.quinot.org/
+/**
+ * DotClear Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ * @author Thomas Quinot
+ * @link http://thomas.quinot.org/
*/
/**
@@ -10,6 +14,15 @@
if(!function_exists('get_comment_count'))
{
+ /**
+ * Get the comment count for posts.
+ *
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param int $post_ID Post ID
+ * @return int
+ */
function get_comment_count($post_ID)
{
global $wpdb;
@@ -19,6 +32,15 @@ function get_comment_count($post_ID)
if(!function_exists('link_exists'))
{
+ /**
+ * Check whether link already exists.
+ *
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $linkname
+ * @return int
+ */
function link_exists($linkname)
{
global $wpdb;
@@ -40,31 +62,73 @@ function link_exists($linkname)
// This cries out for a C-implementation to be included in PHP core
//
+/**
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $char
+ * @return string
+ */
function valid_1byte($char) {
if(!is_int($char)) return false;
return ($char & 0x80) == 0x00;
}
+/**
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $char
+ * @return string
+ */
function valid_2byte($char) {
if(!is_int($char)) return false;
return ($char & 0xE0) == 0xC0;
}
+/**
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $char
+ * @return string
+ */
function valid_3byte($char) {
if(!is_int($char)) return false;
return ($char & 0xF0) == 0xE0;
}
+/**
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $char
+ * @return string
+ */
function valid_4byte($char) {
if(!is_int($char)) return false;
return ($char & 0xF8) == 0xF0;
}
+/**
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $char
+ * @return string
+ */
function valid_nextbyte($char) {
if(!is_int($char)) return false;
return ($char & 0xC0) == 0x80;
}
+/**
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $string
+ * @return string
+ */
function valid_utf8($string) {
$len = strlen($string);
$i = 0;
@@ -92,6 +156,13 @@ function valid_utf8($string) {
return true; // done
}
+/**
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $s
+ * @return string
+ */
function csc ($s) {
if (valid_utf8 ($s)) {
return $s;
@@ -100,13 +171,28 @@ function csc ($s) {
}
}
+/**
+ * @package WordPress
+ * @subpackage Dotclear_Import
+ *
+ * @param string $s
+ * @return string
+ */
function textconv ($s) {
return csc (preg_replace ('|(?<!<br />)\s*\n|', ' ', $s));
}
/**
- The Main Importer Class
-**/
+ * Dotclear Importer class
+ *
+ * Will process the WordPress eXtended RSS files that you upload from the export
+ * file.
+ *
+ * @package WordPress
+ * @subpackage Importer
+ *
+ * @since unknown
+ */
class Dotclear_Import {
function header()
@@ -742,5 +828,7 @@ function Dotclear_Import()
}
$dc_import = new Dotclear_Import();
+
register_importer('dotclear', __('DotClear'), __('Import categories, users, posts, comments, and links from a DotClear blog.'), array ($dc_import, 'dispatch'));
+
?>
@@ -1,5 +1,19 @@
<?php
-
+/**
+ * GreyMatter Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ */
+
+/**
+ * GreyMatter Importer class
+ *
+ * Basic GreyMatter to WordPress importer, will import posts, comments, and
+ * posts karma.
+ *
+ * @since unknown
+ */
class GM_Import {
var $gmnames = array ();
View
@@ -1,5 +1,18 @@
<?php
-
+/**
+ * Jeromes Keyword Plugin Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ */
+
+/**
+ * Jeromes Keyword Plugin Importer class
+ *
+ * Will convert Jeromes Keyword Plugin tags to WordPress taxonomy tags.
+ *
+ * @since 2.3
+ */
class JeromesKeyword_Import {
function header() {
@@ -1,5 +1,18 @@
<?php
-
+/**
+ * LiveJournal Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ */
+
+/**
+ * LiveJournal Importer class
+ *
+ * Imports your LiveJournal XML exported file into WordPress.
+ *
+ * @since unknown
+ */
class LJ_Import {
var $file;
View
@@ -1,5 +1,18 @@
<?php
-
+/**
+ * Movable Type and Typepad Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ */
+
+/**
+ * Moveable Type and Typepad Importer class
+ *
+ * Upload your exported Movable Type or Typepad entries into WordPress.
+ *
+ * @since unknown
+ */
class MT_Import {
var $posts = array ();
View
@@ -1,5 +1,20 @@
<?php
-
+/**
+ * RSS Importer
+ *
+ * @package WordPress
+ * @subpackage Importer
+ */
+
+/**
+ * RSS Importer
+ *
+ * Will process a RSS feed for importing posts into WordPress. This is a very
+ * limited importer and should only be used as the last resort, when no other
+ * importer is available.
+ *
+ * @since unknown
+ */
class RSS_Import {
var $posts = array ();
Oops, something went wrong.

0 comments on commit 7f894ae

Please sign in to comment.