Show
Ignore:
Timestamp:
08/14/08 06:30:38 (3 months ago)
Author:
westi
Message:

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

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/wp-admin/import/dotclear.php

    r7645 r8645  
    11<?php 
    2 /* 
    3  * DotClear import plugin 
    4  * by Thomas Quinot - http://thomas.quinot.org/ 
     2/** 
     3 * DotClear Importer 
     4 * 
     5 * @package WordPress 
     6 * @subpackage Importer 
     7 * @author Thomas Quinot 
     8 * @link http://thomas.quinot.org/ 
    59 */ 
    610 
    …… 
    1115if(!function_exists('get_comment_count')) 
    1216{ 
     17    /** 
     18     * Get the comment count for posts. 
     19     * 
     20     * @package WordPress 
     21     * @subpackage Dotclear_Import 
     22     * 
     23     * @param int $post_ID Post ID 
     24     * @return int 
     25     */ 
    1326    function get_comment_count($post_ID) 
    1427    { 
    …… 
    2033if(!function_exists('link_exists')) 
    2134{ 
     35    /** 
     36     * Check whether link already exists. 
     37     * 
     38     * @package WordPress 
     39     * @subpackage Dotclear_Import 
     40     * 
     41     * @param string $linkname 
     42     * @return int 
     43     */ 
    2244    function link_exists($linkname) 
    2345    { 
    …… 
    4163// 
    4264 
     65/** 
     66 * @package WordPress 
     67 * @subpackage Dotclear_Import 
     68 * 
     69 * @param string $char 
     70 * @return string 
     71 */ 
    4372function valid_1byte($char) { 
    4473    if(!is_int($char)) return false; 
    …… 
    4675} 
    4776 
     77/** 
     78 * @package WordPress 
     79 * @subpackage Dotclear_Import 
     80 * 
     81 * @param string $char 
     82 * @return string 
     83 */ 
    4884function valid_2byte($char) { 
    4985    if(!is_int($char)) return false; 
    …… 
    5187} 
    5288 
     89/** 
     90 * @package WordPress 
     91 * @subpackage Dotclear_Import 
     92 * 
     93 * @param string $char 
     94 * @return string 
     95 */ 
    5396function valid_3byte($char) { 
    5497    if(!is_int($char)) return false; 
    …… 
    5699} 
    57100 
     101/** 
     102 * @package WordPress 
     103 * @subpackage Dotclear_Import 
     104 * 
     105 * @param string $char 
     106 * @return string 
     107 */ 
    58108function valid_4byte($char) { 
    59109    if(!is_int($char)) return false; 
    …… 
    61111} 
    62112 
     113/** 
     114 * @package WordPress 
     115 * @subpackage Dotclear_Import 
     116 * 
     117 * @param string $char 
     118 * @return string 
     119 */ 
    63120function valid_nextbyte($char) { 
    64121    if(!is_int($char)) return false; 
    …… 
    66123} 
    67124 
     125/** 
     126 * @package WordPress 
     127 * @subpackage Dotclear_Import 
     128 * 
     129 * @param string $string 
     130 * @return string 
     131 */ 
    68132function valid_utf8($string) { 
    69133    $len = strlen($string); 
    …… 
    93157} 
    94158 
     159/** 
     160 * @package WordPress 
     161 * @subpackage Dotclear_Import 
     162 * 
     163 * @param string $s 
     164 * @return string 
     165 */ 
    95166function csc ($s) { 
    96167    if (valid_utf8 ($s)) { 
    …… 
    101172} 
    102173 
     174/** 
     175 * @package WordPress 
     176 * @subpackage Dotclear_Import 
     177 * 
     178 * @param string $s 
     179 * @return string 
     180 */ 
    103181function textconv ($s) { 
    104182    return csc (preg_replace ('|(?<!<br />)\s*\n|', ' ', $s)); 
    …… 
    106184 
    107185/** 
    108     The Main Importer Class 
    109 **/ 
     186 * Dotclear Importer class 
     187 * 
     188 * Will process the WordPress eXtended RSS files that you upload from the export 
     189 * file. 
     190 * 
     191 * @package WordPress 
     192 * @subpackage Importer 
     193 * 
     194 * @since unknown 
     195 */ 
    110196class Dotclear_Import { 
    111197 
    …… 
    743829 
    744830$dc_import = new Dotclear_Import(); 
     831 
    745832register_importer('dotclear', __('DotClear'), __('Import categories, users, posts, comments, and links from a DotClear blog.'), array ($dc_import, 'dispatch')); 
     833 
    746834?>