arrayfire
arrayfire

Reputation: 1754

Embed doxygen in mediawiki

I use mediawiki for the majority of my documentation. However, we recently started using doxygen to document the API on one of our C/C++ heavy projects. To give our overall documentation a consistent look & feel, I'd like to embed the doxygen stuff into mediawiki. How should I do that?

I've looked at some of the extensions, but everything I've found so far seems half-baked.

Upvotes: 7

Views: 2797

Answers (2)

skierpage
skierpage

Reputation: 2584

I haven't tried DoxyWiki.

You could code a wiki Special page like Special:FileSystem or set up a namespace whose "subpages" correspond to doxygen HTML files in the file system. The problem is doxygen wants to render its own navigation which is kinda incompatible with a typical MediaWiki skin's sidebar and such.

You could put the doxygen HTML files in another directory on your web server and link to them. To make this cleaner you could define an interwiki prefix for it, like "docs", and then you can link to the doxygen web pages withh regular wiki links [[docs:php/Action_8php.html|see the Action.php reference docs]]. You could skin the doxygen output to make it look more like your wiki's skin. But your wiki's search box won't return doxygen matches.

Upvotes: 0

The only extension I know of is DoxyWiki. I think that's all that is available right now.

But perhaps that is what you meant by "half-baked"?

(See also: Wikis and Wikipedia)

Upvotes: 2

Related Questions