I am new to Doxygen and have been able to create todo items in a module. Can I create a global todo list or is there a better way to get all the todo items in one place?
All the to do items (created using the doxygen command \todo) appear together on a page called "Todo list", which is located under the "Related Pages" tab (see the image below). This page is a "global" to do list for the whole project. Notice that a page is also created for lists of bugs (cf \bug).
You can also make your own custom pages appear under the "Related Pages" tab using the generalization of the \todo and \bug commands,
\xrefitem. See the \xrefitem documentation for an example which adds a "Reminders" page.
You can create a tagfile output and use it as input to another Doxygen configuration, but I've not yet successfully gotten xrefitem pages to import that way.
You can export to xml and have a parser read all your todo.xml files and combine them.
Related
The struct plugin is nice for managing structured data. But so far the only way I found to present the data for one single entry is a simple automatically generated table at the top of the page followed by the content of the entrys wiki text. Since I need the single entry pages to look better, I want to replace the simple table with something more pleasing to the eye like a template page that gets included into the page itself using {page>_mytemplate}.
The mytemplate wiki page might look like this:
==== STRUCTFIELD_TITLE ====
The STRUCTFIELD_NAME is a STRUCTFIELD_CLASSIFICATION consisting
of STRUCTFIELD_INGREDIENTS.
"STRUCTFIELD_*" should be replaced with the fields defined in the schema of course.
The wiki page of the single entry should include the template page as mentioned above with {page>mytemplate}.
So my question in essence is: How to include single fields of a schema into a wiki page as template variables, and can this be further automated using one "template wiki page" that gets included via the {page>...} command?
Found a solution. It is discussed in detail here: https://github.com/cosmocode/dokuwiki-plugin-struct/issues/145
In a nutshell: There is a version of the Struct plugin which includes all the functionality needed: https://github.com/iainhallam/dokuwiki-plugin-struct/tree/feature/value
When using markdown with doxygen, the documentation generates fine. However, I have one problem, which is that my documentation generates a related pages tab which is empty. For example, here is my main page:
# Project Name
Contents
This documentation is divided into the following sections:
- \subpage page_one
- \subpage page_two
And here is a sample subpage:
# Page One {#page_one}
Content
When I generate my documentation, I get the expected tree structure. However, when I click Related Pages, this is what I get:
Obviously, I have no benefit from an empty related pages tab. Thus, is there any way to get rid of this empty tab? If so, how should I change my Doxyfile?
You have defined the top page as USE_MDFILE_AS_MAINPAGE and all other pages are direct or indirect sub-pages of this page.
The display of the Related Pages is steered by means of the DoxygenLayout.xml (can be generated by means of doxygen -l, see also LAYOUT_FILE) and in here there is an item pages, when setting this item to no the Related Pages tab is not generated.
I have a library for which I am generating doxygen documentation.
There is a module (module_A) in that library which contains a description of various details in relation to this module (on generated page group_moduleA.html).
I want to add several pages to give additional details about that module, which I will then link to from the module page. However, I do not want those pages to be visible in any of the left hand menu. I only want them to be linked to from the group_moduleA.html page and nowhere else.
Is there any way to do that?
I cannot use \page, as a page will be added in the left hand menu if I do that.
I'm trying to achieve the same functionality as Qt is having for their documentation with navigation path working same as Windows 7-8 (maybe also vista) i.e. showing whole path from root (module M) to component C and class X. M->C->X
Good example:
http://doc.qt.io/qt-4.8/qnetworksession.html
Must I put some kind of doxygen tags for root and it's child's their subchild's? I checked all the doxygen tags without seeing anything related to navigation path.
I am working with doxygen 1.8.7 which generates navigation path in footer, but everything i click is being displayed as root. Also, how can i put navigation on top of the page/header?
And is it possible to have group table of content displayed? I am having separated model.dox file for each module, which defines new group and contains sections/subsections. Any ideas why table of contents isn't displayed? Everything works well on (main) page using \mainpage \page tag.
Example of my group:
/*! \defgroup module1 CommonModule
*
* \tableofcontents
*
* Module description ..
* \section first Init
*/
Update 14.7.2014:
Didn't realize Qt documentation is build using qdoc tool, not doxygen so Edit section can be ignored. Questions still remain the same. From what I've experienced it is impossible to group pages and groups together therefor making it impossible to generate module page with list of all classes/namespaces/enums etc. Hopefully I am wrong.
Update 11.9.2014:
Page can not contain autogenerated list of all classes/namespaces/enums etc.
Doxygen navigation only shows file path when browsing over file list which isn't that useful since i am mostly browsing the documentation by class/namespace not by file and wish to have file list generation disabled.
Edit:
From checking Qt documentation (source) i see that Qt modules are all doxygen pages and modules page is manually written and not auto generated by doxygen since they probably couldn't get module description with table of content using \defgroup. Will do he same if needed.
Navigation path on the other hand is still a big mystery, they might have used some kind of internal scripting as i see custom tags such as \nextpage. It's strange how it's so difficult to find anything related to doxygen navigation on google!
I have a several html pages explaining different parts of my code, and I've recently ran Doxygen on it as well. I would like to add links to my current html pages under the Doxygen'd "Related Pages" page.
Is there a way to do this other than manually inserting them?
Look at Doxygen \page command documentation.