Hi,
as you have found out, the Doxygen INPUT variable is "hard-coded" to
"${CMAKE_CURRENT_SOURCE_DIR}/documentation/UserManual" for every
plug-in. The intention was that the documentation which shows up in the
application is typcially end-user oriented and should not contain API
documentation or similar.
However, we certainly could add something like you are suggestion in 2.
Please add a feature request to our bug tracking system
(http://bugs.mitk.org) and add me CC or as the assignee.
Thanks,
Sascha
On 07/26/2013 04:56 PM, Rachit Jain wrote:
Hi MITK Community
I am developing an application (C++, QT on windows) using MITK and by
enabling BLUEBERRY_USE_QT_HELP in MITK, I can see the documentation
generated nicely. In application, pressing F1 on any of my (and MITK)
plug-in's, the documentation appears nicely as mentioned in the
Manual.dox file.
Right now I have a need to specify a tag/section from one of my source
files (.h) also in the Manual.dox file for my plug-in. So below are my
questions:
1. Is it possible currently possible in MITK to refer some section of
source file in Manual.dox file. So that when my application is
running, I can see documentation/section of source file(s) as well.
2. Debugging revealed me that currently in MITK file
MacroCreateCTKPlugin.cmake file, the flag PLUGIN_DOXYGEN_INPUT_DIR is
hard-coded to "${CMAKE_CURRENT_SOURCE_DIR}/documentation/UserManual".
Is it possible for you to provide an option so that I can pass my list
of files. So that it goes in "INPUT" section of generated doxygen.conf
file. This will help me as when doxygen will run and read this
doxygen.conf file, it will generate the documentation and then in my
Manual.dox file, I will be able to happily refer and use it.
While searching more on doxygen/blogs, I also found that there is
concept of .tag file, that can be used. But currently I don't know
much detail about it.
I would appreciate your help on this topic.
Thanks and Regards
Rachit Jain
------------------------------------------------------------------------------
See everything from the browser to the database with AppDynamics
Get end-to-end visibility with application monitoring from AppDynamics
Isolate bottlenecks and diagnose root cause in seconds.
Start your free trial of AppDynamics Pro today!
http://pubads.g.doubleclick.net/gampad/clk?id=48808831&iu=/4140/ostg.clktrk
_______________________________________________
mitk-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/mitk-users
