kapidox: Add support for dependency diagrams

Alex Merry kde at randomguy3.me.uk
Thu Jan 16 17:29:19 UTC 2014


On 16/01/14 16:58, Aurélien Gâteau wrote:
> 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?

Seems sensible; do we want to run the dependency diagram generator from
kgenframeworksapidox.py?

> 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.

I'm waiting for someone to sanity-check my git-merge-fu for kdoctools
(kde:clones/kdoctools/alexmerry/kapidox-merge) before I remove those
files from kapidox.  Once that's done, I'll rebase my branch and push to
master.

Alex



More information about the Kde-frameworks-devel mailing list