[TYPO3-doc] Cross-linking to Doxygen

Xavier Perseguers xavier at typo3.org
Thu Aug 22 16:45:36 CEST 2013


Hi,

> You will find a PoC that cross-linking to a doxygen documentation is
> possible with Sphinx here:
> 
> http://forge.typo3.org/issues/41430

Now supporting methods within classes with a straightforward anchor name:

Please see class :ref:`sphinxapi:\\Causal\\Sphinx\\Utility\\SphinxBuilder`.

Please see method
:ref:`sphinxapi:\\Causal\\Sphinx\\Utility\\SphinxBuilder::buildPdf`.

I cannot think of something easier than this!

So next step is really to get in touch with the persons involved into
generating API with Doxygen to let them run my bash script on the output
and then to simply document how to link to a given file. It's so easy :)

We could even think of generating an API documentation for each
extension, to let extension authors link to their own code as well...

Cheers

-- 
Xavier Perseguers
Release Manager TYPO3 4.6

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org



More information about the TYPO3-project-documentation mailing list