kapidox: Add support for dependency diagrams

Aurélien Gâteau agateau at kde.org
Thu Jan 16 16:58:54 UTC 2014


Hi Alex,

This patch adds support for including dependency diagrams to
kgenapidox.py. It applies on top of
kde:clones/kapidox/alexmerry/kapidox, using the frameworks branch.

The way it works is as follow:

Start kgenapidox.py with the --dependency-diagram-dir option. It should
point to a dir which contains a file named $projectname.png

When started like this, the script will do a few things:
- Copy $projectname.png as $PWD/dependencies.png
- Add $PWD/dependencies.png to the list of image paths
- Add common/dependencies.md to the list of input files. dependencies.md
just contains a ref to a dependencies.png image
- A new entry in the sidebar: "Dependencies" will be generated

Opinions?

Aurélien

PS: I think it is time to merge your branch into the main repository,
this way we can use reviewboard. It is not going to break anything since
api.kde.org still uses the apidox from kdelibs, as far as I know.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-Add-support-for-including-dependency-diagrams.patch
Type: text/x-patch
Size: 6839 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140116/864b58e1/attachment.patch>


More information about the Kde-frameworks-devel mailing list