<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>.wpal &#187; phpDocumentor</title>
	<atom:link href="http://blog.web2.com.ua/tag/phpdocumentor/feed/" rel="self" type="application/rss+xml" />
	<link>http://blog.web2.com.ua</link>
	<description>web, programming and linux</description>
	<lastBuildDate>Fri, 20 May 2011 13:29:04 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.1.2</generator>
		<item>
		<title>Интеграция phpDocumentor в Eclipse</title>
		<link>http://blog.web2.com.ua/2008/09/11/integratsiya-phpdocumentor-v-eclipse/</link>
		<comments>http://blog.web2.com.ua/2008/09/11/integratsiya-phpdocumentor-v-eclipse/#comments</comments>
		<pubDate>Thu, 11 Sep 2008 13:30:49 +0000</pubDate>
		<dc:creator>wert2all</dc:creator>
				<category><![CDATA[php]]></category>
		<category><![CDATA[программирование]]></category>
		<category><![CDATA[eclipse]]></category>
		<category><![CDATA[phpDocumentor]]></category>
		<category><![CDATA[интеграция]]></category>

		<guid isPermaLink="false">http://blog.web2.com.ua/?p=648</guid>
		<description><![CDATA[Вот сижу, пишу код, иногда пишу комментарии. Идилия. Но вот, написавши n-ий класс, столкнулся с проблемой документации его. Ведь не только я же буду им пользоваться, а писать самому, когда есть описания методов &#8211; это не путь юного падавана. Тут на помощь приходит phpDocumentor. Но его надо бы врикрутить в среду разработки, тоесть в Eclipse, [...]]]></description>
			<content:encoded><![CDATA[<p>Вот сижу, пишу код, иногда пишу комментарии. Идилия. Но вот, написавши n-ий класс, столкнулся с проблемой документации его. Ведь не только я же буду им пользоваться, а писать самому, когда есть описания методов &#8211; это не путь юного падавана. Тут на помощь приходит phpDocumentor. Но его надо бы врикрутить в среду разработки, тоесть в Eclipse, чем и займёмся.<span id="more-648"></span></p>
<p>Уже всем известно, что я использую Linux, точнее openSUSE. Это очень многое упрощает.</p>
<p>Сначала надо добавить репозитарий с phpDoc. Это просто:</p>
<pre><code>zypper ar http://download.opensuse.org/repositories/server:/php:/applications/openSUSE_11.0/server:php:applications.repo</code></pre>
<p>Теперь устанавливаем phpDocumentor:</p>
<pre><code>zypper in php5-pear-phpdocumentor</code></pre>
<p>Всё уже есть, осталось натравить на него Eclipse. Для этого добавляем скрипт с помощью меню Run -&gt; External Tools -&gt;Open External Tools Dialog. Вот так окно диалога выглядит:</p>
<ul class="picture">
<li><a href="http://blog.web2.com.ua/wp-content/uploads/external_dialog.png" target="_blank"><img title="external_dialog" src="http://blog.web2.com.ua/wp-content/uploads/external_dialog-400x320.png" alt="" width="400" height="320" /></a></li>
<li>Добавления скрипта</li>
</ul>
<p>Добавим новый скрипт, методом нажатия New. В поле Name вписываем названия скрипта, например  phpDocumentor. В поле Location вставляем полний путь к phpDoc, у меня /usr/bin/phpdoc. В Working Directory &#8211; путь к установленому phpDoc &#8211; /usr/share/php5/PEAR/PhpDocumentor/. Самое интересное находится в поле аргументов. В нём записываются параметры phpDoc для генерации документации. Я прописал такие:</p>
<pre><code>-f "${resource_loc}" -t "${project_loc}/phpDoc" -o HTML:Smarty:HandS</code></pre>
<p>Это означает, что следует создать докуменацию с активного файла проекта с помощью шалонов HTML:Smarty:HandS ( более широко о шаблонах и их типах, написано в <a title="phpDocumentor HowTo" href="http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.output" target="_blank">документации</a> ) и результат положить в папку phpDoc внутри проэкта.</p>
<p>Вот что получилось:</p>
<ul class="picture">
<li><a href="http://blog.web2.com.ua/wp-content/uploads/action.png" target="_blank"><img title="action" src="http://blog.web2.com.ua/wp-content/uploads/action-400x320.png" alt="" width="400" height="320" /></a></li>
<li>Вот и весь скрипт</li>
</ul>
<p>Если всё правильно сделали, то в меню появится пункт для запуска phpDoc и папочка с документацией. Более нужной функцией будет формирование документации по всему проекту. Для этого я создал ещё один, но с другими параметрами:</p>
<pre><code>-d " ${project_loc}" -t "${project_loc}/phpDoc" -o HTML:Smarty:HandS -i *.svn/* -i *phpDoc/*</code></pre>
<p>И как-бы нет ничего сложного.</p>
]]></content:encoded>
			<wfw:commentRss>http://blog.web2.com.ua/2008/09/11/integratsiya-phpdocumentor-v-eclipse/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
	</channel>
</rss>

