ネットランダム改変

はてなダイアリーからはてなブログにインポート。

PhpDocumentorを使ってみた

ではさっそく「phpDocumentor」をインストールしよう

ubuntu-user@ubuntu-machine:~$ pear install --alldeps phpdocumentor
No releases available for package "pear.php.net/phpdocumentor"
install failed

「リリースはありません。インストールは失敗しました。」だってお


ぐぐってると、インストール時にメモリ不足だの、検索結果からたどったら500エラーのページだのがあって不安になった。

しかし↓ここにダウンロードしてインストールする方法があったのだ。

phpDocumentor - phpspot

PhpDocumentor-1.4.3.tgzをダウンロードした。

解凍して、/usr/share/にコピーした。

docs/PhpProject1/フォルダを作成し、PhpProject1のソースを格納する予定。

ubuntu-user@ubuntu-machine:~$ php phpdoc -d /home/ubuntu-user/NetBeansProjects/PhpProject1/ -t /home/ubuntu-user/NetBeansProjects/docs/PhpProject1/
Could not open input file: phpdoc

失敗。
PATHを通してもだめだった。権限がなかった。

ubuntu-user@ubuntu-machine:~$ cd /usr/share/PhpDocumentor-1.4.3/
ubuntu-user@ubuntu-machine:/usr/share/PhpDocumentor-1.4.3$ sudo php phpdoc -d /home/ubuntu-user/NetBeansProjects/PhpProject1/ -t /home/ubuntu-user/NetBeansProjects/docs/PhpProject1/
if [ -z "$PHP" ]; then
   PHP=`which php`
fi
(exec $PHP -C -q -d output_buffering=1 "$0" "$@") 2>/dev/null
if [ "$?" -ne "0" ]; then
	echo "FAILED:  Bad environment variable \$PHP (set to \"$PHP\")"
	exit 1
fi
exit 0
PHP Notice:  ob_end_clean(): failed to delete buffer. No buffer to delete. in /usr/share/PhpDocumentor-1.4.3/phpdoc on line 50
PHP Stack trace:
PHP   1. {main}() /usr/share/PhpDocumentor-1.4.3/phpdoc:0
PHP   2. ob_end_clean() /usr/share/PhpDocumentor-1.4.3/phpdoc:50
PHP Version 5.3.2-1ubuntu4.2
phpDocumentor version 1.4.3

Parsing configuration file phpDocumentor.ini...
   (found in /usr/share/PhpDocumentor-1.4.3/)...

done
Maximum memory usage setting disabled by php.ini...
using tokenizer Parser


Grabbing README/INSTALL/CHANGELOG

done


Tutorial/Extended Documentation Parsing Stage

done


General Parsing Stage

Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/Includes/db.php -- Parsing file
WARNING in db.php on line 1: no @package tag was used in a DocBlock for class WishDB
WARNING in db.php on line 100: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/Includes/db.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/wishlist.css -- File not parsed, not a php file
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/editWishList.php -- Parsing file
WARNING in editWishList.php on line 62: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/editWishList.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/phpinfoview.php -- Parsing file
WARNING in phpinfoview.php on line 6: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/phpinfoview.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/nbproject/project.xml -- File not parsed, not a php file
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/nbproject/private/private.xml -- File not parsed, not a php file
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/nbproject/private/config.properties -- File not parsed, not a php file
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/nbproject/private/private.properties -- File not parsed, not a php file
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/nbproject/project.properties -- File not parsed, not a php file
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/deleteWish.php -- Parsing file
WARNING in deleteWish.php on line 5: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/deleteWish.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/editWish.php -- Parsing file
WARNING in editWish.php on line 75: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/editWish.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/images/background1.gif -- File not parsed, not a php file
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/images/background2.png -- File not parsed, not a php file
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/index.php -- Parsing file
WARNING in index.php on line 70: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/index.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/createNewWisher.php -- Parsing file
WARNING in createNewWisher.php on line 89: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/createNewWisher.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/mbconvertencoding.php -- Parsing file
WARNING in mbconvertencoding.php on line 19: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/mbconvertencoding.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/wishlist.php -- Parsing file
WARNING in wishlist.php on line 34: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/wishlist.php" has no page-level DocBlock, use @package in the first DocBlock to create one
Reading file /home/ubuntu-user/NetBeansProjects/PhpProject1/bookmarklist.php -- Parsing file
WARNING in bookmarklist.php on line 36: File "/home/ubuntu-user/NetBeansProjects/PhpProject1/bookmarklist.php" has no page-level DocBlock, use @package in the first DocBlock to create one
done

Converting From Abstract Parsed Data

Processing Class Inheritance


Processing Root Trees


Processing leftover classes (classes that extend root classes not found in the same package)
done processing leftover classes

Processing Procedural Page Element Name Conflicts


Sorting page elements...done
Formatting @uses list...done

creating /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//media
Creating Directory /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//media
copying /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//media/banner.css
copying /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//media/stylesheet.css
Building indexes...done

Sorting Indexes...done

Sorting @todo list...done
Converting tutorials/extended docs
Formatting Package Indexes...    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//elementindex_default.html

done
Formatting Index...
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//elementindex.html
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//blank.html

    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//index.html
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//packages.html
done

Formatting Left Quick Index...
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//li_default.html
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//classtrees_default.html

done

Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/bookmarklist.php Procedural Page Elements... Classes... done
Creating Directory /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_bookmarklist.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/createNewWisher.php Procedural Page Elements... Classes... done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_createNewWisher.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/Includes/db.php Procedural Page Elements... Classes...
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/WishDB.html
 done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_Includes---db.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/deleteWish.php Procedural Page Elements... Classes... done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_deleteWish.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/editWish.php Procedural Page Elements... Classes... done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_editWish.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/editWishList.php Procedural Page Elements... Classes... done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_editWishList.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/index.php Procedural Page Elements... Classes... done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_index.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/mbconvertencoding.php Procedural Page Elements... Classes... done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_mbconvertencoding.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/phpinfoview.php Procedural Page Elements... Classes... done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_phpinfoview.php.html
Converting /home/ubuntu-user/NetBeansProjects/PhpProject1/wishlist.php Procedural Page Elements... Classes... done
    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//default/_wishlist.php.html

Converting @todo List...done

Converting Error Log...    Writing /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//errors.html


To view errors and warnings, look at /home/ubuntu-user/NetBeansProjects/docs/PhpProject1//errors.html
done

Parsing time: 1 seconds

Conversion time: 1 seconds

Total Documentation Time: 2 seconds
done
ubuntu-user@ubuntu-machine:/usr/share/PhpDocumentor-1.4.3$

できた！

docs/PhpProject1/フォルダをpublic_htmlにコピーして、表示できた！

かっこいい！