[TYPO3] API doc generation using doxygen

Xavier Perseguers typo3 at perseguers.ch
Mon Aug 11 08:21:56 CEST 2008


Hi,

>> I want to generate my own documentation running doxygen over any 
>> version of typo3 source directory. I have installed doxygen package on 
>> my Ubuntu machine.
>>
>> Can anybody please give quick guidance on how to do it?
> 
> TYPO3 uses phpDoc. Once I generated the documentation easily with 
> phpDoc's own tools.

Here is what I do for phpDoc after reading their documentation. Put this 
script into root of TYPO3's source directory and run it:

#!/bin/bash
TITLE="TYPO3 4.2.1 API"
PACKAGES="default"
PATH_PROJECT=$PWD
PATH_PHPDOC=/usr/bin/phpdoc
PATH_DOCS=$PWD/docs
OUTPUTFORMAT=HTML
CONVERTER=frames
TEMPLATE=default
PRIVATE=off

# make documentation
"$PATH_PHPDOC" -d "$PATH_PROJECT" -t "$PATH_DOCS" -ti "$TITLE" -dn 
$PACKAGES -o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE

You should find a similar way to do this with doxygen. They have a good 
documentation too.

-- 
Xavier Perseguers
http://xavier.perseguers.ch/en/tutorials/typo3.html


More information about the TYPO3-english mailing list