Modify

Ticket #2937 (closed Bugs: fixed)

Opened 5 years ago

Last modified 5 years ago

Workaround buggy XML from doxygen

Reported by: danieljames Owned by: danieljames
Milestone: Boost 1.39.0 Component: Documentation
Version: Boost Development Trunk Severity: Problem
Keywords: Cc:

Description

For this code:

    template <typename TypeParameter, int NonTypeParameter,
        typename TypeParameterWithDefault = int>
    struct example_template {};

Doxygen 1.5.6 would generates the parameter list:

    <templateparamlist>
      <param>
        <type>typename</type>
        <declname>TypeParameter</declname>
        <defname>TypeParameter</defname>
      </param>
      <param>
        <type>int</type>
        <declname>NonTypeParameter</declname>
        <defname>NonTypeParameter</defname>
      </param>
      <param>
        <type>typename</type>
        <declname>TypeParameterWithDefault</declname>
        <defname>TypeParameterWithDefault</defname>
        <defval>int</defval>
      </param>
    </templateparamlist>

But Doxygen 1.5.8 generates:

    <templateparamlist>
      <param>
        <type>typename TypeParameter</type>
      </param>
      <param>
        <type>int</type>
        <declname>NonTypeParameter</declname>
        <defname>NonTypeParameter</defname>
      </param>
      <param>
        <type>typename TypeParameterWithDefault</type>
        <defval>int</defval>
      </param>
    </templateparamlist>

Note that the names of type parameters are inside the type. This is confusing doxygen2boostbook and I need to work around it.

Attachments

Change History

comment:1 Changed 5 years ago by danieljames

  • Status changed from new to assigned

Workaround in [52326].

comment:2 Changed 5 years ago by danieljames

  • Status changed from assigned to closed
  • Resolution set to fixed

Merged to release in [52345].

View

Add a comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
The resolution will be deleted. Next status will be 'reopened'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.