Page MenuHomePhabricator
Create Task
Maniphest T30227

Link error between plugins F1-Help files
Open, NormalPublic
Actions

Description

In the doxygen plugin F1-help the links to other plugins help pages or sections within other plugin help pages do not work currently when using the doxygen \ref functionality. This is only true for the F1-help, for generated user documentation the links work.
In order to resolve the links also in the F1-help, the plugin to which the \ref refers to must be included in the manifest_headers.cmake file as Require-Plugin.
This issue was found in the following plugins (however, not all plugins were checken and there might be more occurances):

  • org.mitk.gui.qt.matchpoint.algorithm.browser
  • org.mitk.gui.qt.matchpoint.algorithm.control
  • org.mitk.gui.qt.matchpoint.framereg
  • org.mitk.gui.qt.matchpoint.manipulator

Pay attention to the order of the plugins in the PluginList.cmake. A certain plugin can include only plugins which are located above this certain plugin in the list.

Remark: For the pharmacokinetics and modelFit related plugins this issue has also been found. It will be fixed as part of the updates of the manual for the 2023.10 release.

Event Timeline

kompan triaged this task as Normal priority.Oct 17 2023, 10:32 AM
kompan created this task.
kompan updated the task description. (Show Details)Oct 18 2023, 11:06 AM
kompan removed a subscriber: kompan.
kompan added a comment.Oct 18 2023, 11:23 AM

At the moment it is not very elegant to generate plugin-dependencies just for the documentation. And this solution also does't allow for having references in two-ways between plugins (refer plugin B in plugin A and vice versa). A different approach could be an additional entry in the manifest_header.cmake just for documentation dependecies or to take all references into account for all plugins.

MITK · MIC · IMSY · DKFZ