[Doxygen-users] Options for tweaking how connections are made
Brought to you by:
dimitri
From: Seaders O. <sea...@gm...> - 2016-01-11 15:44:19
|
I posted one part of my question to StackOverflow, http://stackoverflow.com/questions/34639432/syntactical-sugar-for-doxygen-to-link-a-monobehaviour-with-unity3d, but it hasn't gotten a huge response, so thought I might be better trying here. Basically, I'd like to be able to add some sort of syntactical sugar, meta information, or configuration to enable Doxygen to manually enter a connection into it. One example of this is the SO question, to create a new MonoBehaviour, in the proper Unity3d environment, you pass a classfile to be added to an active GameObject, and Unity takes care of the rest. So, while your code will call the new MonoBehaviour's constructor, Awake, and Start methods, that doesn't get tracked and then doesn't get shown in the graphs. On a similar level, if you're making cross-platform apps, you will also have native Java and iOS code, but you create these with meta functions, that connect with exposed functions from the native side. Again, I don't in any way know how Doxygen could do this, nor expect it to be able to do it automatically, but if it's possible, I'd love to be able to add some syntactical sugar that lets Doxygen know this connection should be made to some function on Unity's side in C#, and the native side in Java / Objective-C in the docs. Then, on the other side I'd also like to mark some connections as not to be tracked by Doxygen. A simple example of when you'd want this is in an iOS / XCode project, so that it would ignore that things inherit from NSObject, because in a large project, it results in hundreds of files showing as children of it. Last question is a more general version of filtering things out from Doxygen / GraphViz. Currently if I run it against my Android project, it makes a number of connections to Android .R files ("android.support.design.R" / "android.support.v7.appcompat.R"), which again are unwanted. Is the only way to exclude some references to some files by literally excluding the files / directories these classes are coming from, or is there any "meta" way to exclude classes or packages within Doxygen? Many thanks for Doxygen and any and all support, it's all very much appreciated. |