Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XML output: table caption doesn't have ID #8932

Closed
canton7 opened this issue Dec 2, 2021 · 3 comments
Closed

XML output: table caption doesn't have ID #8932

canton7 opened this issue Dec 2, 2021 · 3 comments
Labels
bug DocBook DocBook output RTF XML XML Output

Comments

@canton7
Copy link

canton7 commented Dec 2, 2021

Describe the bug

Doxygen lets you specify a table caption ID with:

<table>
<caption id="multi_row">Complex table</caption>
...
</table>

and then refer to the ID using \ref.

However, the caption ID isn't emitted anywhere in the XML. In compound.xsd, docTableType is given as:

<xsd:complexType name="docTableType">
  <xsd:sequence>
    <xsd:element name="caption" type="docCaptionType" minOccurs="0" maxOccurs="1" />
    <xsd:element name="row" type="docRowType" minOccurs="0" maxOccurs="unbounded" />
  </xsd:sequence>
  <xsd:attribute name="rows" type="xsd:integer" />
  <xsd:attribute name="cols" type="xsd:integer" />
  <xsd:attribute name="width" type="xsd:string" />
</xsd:complexType>

and the docCaptionType is given as:

<xsd:complexType name="docCaptionType" mixed="true">
  <xsd:group ref="docTitleCmdGroup" minOccurs="0" maxOccurs="unbounded" />
</xsd:complexType>

There's no space for the caption ID. I get a <ref refid="group___test_1multi_row" kindref="member">Complex table</ref>, but the ID group___test_1multi_row doesn't appear anywhere else, so I end up with a link to something non-existent.

Expected behavior

The XML output should contain a table caption's ID.

To Reproduce

/**
 * <table>
 * <caption id="multi_row">Complex table</caption>
 * <tr>
 *  <td>Cell 1</td><td>Cell 2</td>
 * </tr>
 * </table>
 * 
 * A ref to \ref multi_row
 */

Version

1.9.2 (caa4e3d) on Windows 64-bit, from the installer on the website.

Thanks!

@albert-github albert-github added bug XML XML Output DocBook DocBook output RTF labels Dec 3, 2021
albert-github added a commit to albert-github/doxygen that referenced this issue Dec 3, 2021
The id of the caption was not only missing for Xml but also for rtf and docbook.

@doxygen Note: addon/doxmlparser/doxmlparser/compound.py has to be regenerated as well.
@albert-github
Copy link
Collaborator

I've just pushed a proposed patch, pull request #8938

@albert-github albert-github added the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Dec 4, 2021
@albert-github
Copy link
Collaborator

Code has been integrated in master on GitHub (please don't close the issue as this will be done at the moment of an official release).

@doxygen
Copy link
Owner

doxygen commented Dec 31, 2021

This issue was previously marked 'fixed but not released',
which means it should be fixed in doxygen version 1.9.3.
Please verify if this is indeed the case. Reopen the
issue if you think it is not fixed and please include any additional information
that you think can be relevant (preferably in the form of a self-contained example).

@doxygen doxygen removed the fixed but not released Bug is fixed in github, but still needs to make its way to an official release label Dec 31, 2021
@doxygen doxygen closed this as completed Dec 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug DocBook DocBook output RTF XML XML Output
Projects
None yet
Development

No branches or pull requests

3 participants