Doxygen - Revision history

Jason: Doxygen update instructies toegevoegd

2018-05-15T19:56:45Z

Doxygen update instructies toegevoegd

Timb: /* Persoonlijke docusites */

2017-12-22T12:36:08Z

‎Persoonlijke docusites

Timb: Created page with "'''Doxygen''' is een programma dat volautomatisch code omzet in klikbare documentatiepagina. De documentatie voor de livesite is te vinden op [https://doxygen-www.a-eskwadraat..."

2017-12-22T11:48:17Z

Created page with "'''Doxygen''' is een programma dat volautomatisch code omzet in klikbare documentatiepagina. De documentatie voor de livesite is te vinden op [https://doxygen-www.a-eskwadraat..."

New page

'''Doxygen''' is een programma dat volautomatisch code omzet in klikbare documentatiepagina. De documentatie voor de livesite is te vinden op [https://doxygen-www.a-eskwadraat.nl].

= Persoonlijke docusites =

'''WORK IN PROGRESS'''

Dit gaat over het plan van [[User:Timb]] om per debugsite documentatie te genereren. Dan zou voor een <code>$bla-debug</code> de site <code>$bla-docs-debug.a-eskwadraat.nl</code> beschikbaar moeten zijn.

== Gebruik ==

<code>./manage docs</code> genereert documentatie op basis van je huidige wwwdebug. TODO: automatiseer dit dmv een script elke nacht ofzo?

= PHPDoc =

We zouden ook [https://docs.phpdoc.org/ phpdoc] kunnen gebruiken. Binnen de PHP-community lijkt het iets gebruikelijker om phpdoc te gebruiken, namelijk. Bovendien ziet het er gewoon cooler uit :D

Helaas crasht het bij het genereren van documentatie omdat het meer dan 2GB aan RAM / schijfruimte nodig heeft om de hele WhosWho te documenteren. Dus vandaar toch maar gewoon doxygen...

== Installatie ==

<strike><code>pear install phpdoc</code> op de [[vm-www-debug]]</strike> Oh nee, dat is niet stabiel over composer updaten.

Zet het volgende in je <code>composer.json</code>
<code><pre>
"require-dev": {
"phpdocumentor/phpdocumentor": "2.*"
}
</pre></code>
en run <code>./composer update</code>. Dit kost even want het moet erg veel dependencies naar binnen slurpen.

[[Category:WebCie]]

← Older revision		Revision as of 19:56, 15 May 2018
Line 12:		Line 12:

	Dit zeurt over een aantal files die Doxygen zou moeten negeren maar dat niet doet. Geen idee waarom.		Dit zeurt over een aantal files die Doxygen zou moeten negeren maar dat niet doet. Geen idee waarom.
		+
		+	== Doxygen updaten ==
		+
		+	Omdat CentOS ongelofelijk oud is is de laatste versie van doxygen op de package manager 1.6.1. Om een nieuwere versie te installeren zijn er 2 mogelijkheden:
		+
		+	*Deinstaalleer doxygen als dit nog geinstalleerd is met yum: sudo yum remove doxygen
		+	*Download de binary van http://www.stack.nl/~dimitri/doxygen/download.html
		+	*Verplaats de binary naar /usr/bin/doxygen (Zorg voor -rwxr-xr-x permissies met de file owner as root)
		+
		+	Omdat vooraf gemaakte binaries saai zijn en zo kunnen we het ook zelf compilen!
		+
		+	<code><pre>
		+	git clone https://github.com/doxygen/doxygen.git
		+	cd doxygen
		+	mkdir build
		+	cd build
		+	cmake -G "Unix Makefiles" ..
		+	make
		+	make install
		+	</pre></code>
		+
		+	Verplaats dan de binary van /usr/local/bin/doxygen naar /usr/bin/doxygen

	= PHPDoc =		= PHPDoc =

← Older revision		Revision as of 12:36, 22 December 2017
Line 10:		Line 10:

	<code>./manage docs</code> genereert documentatie op basis van je huidige wwwdebug. TODO: automatiseer dit dmv een script elke nacht ofzo?		<code>./manage docs</code> genereert documentatie op basis van je huidige wwwdebug. TODO: automatiseer dit dmv een script elke nacht ofzo?
		+
		+	Dit zeurt over een aantal files die Doxygen zou moeten negeren maar dat niet doet. Geen idee waarom.

	= PHPDoc =		= PHPDoc =