search

dita-community / doxygen2dita

Open Toolkit plugins for converting Doxygen XML to DITA maps and topics
Apache License 2.0
5 stars 1 forks source link

Incorrect section closure in file documentation results in validation error #6

Open amantalwar04 opened 8 years ago

amantalwar04 commented 8 years ago

Hi, While working with the transforms, I realized that the generated .dita files for the file documentation (for all the .c & .h files that are a part of the source files) have an incorrect section closure. For example, see the following:

   <reference id="d19e1616" outputclass="detaileddescription">
        <title>Detailed Description</title>
        <refbody>
            <section><p>This is a brief description.</p></section>
            <p>This file contains the definitions to be used when accessing the XYZ Flash. If any new definitions are added to this file, check if they need to be added to the pqr.h file too.</p>
            <note><p>For more details, refer to ABC.</p></note>
            <p/>
            <p/>
            <p> </p>
        </refbody>
    </reference>
`
I assume, that the transform is only capturing the brief description and enclosing it within the `<section></section>` tags. The detailed description is not included within the `<section>` tag resulting in a validation error.
drmacro commented 8 years ago

Can you provide the doxygen-generated XML you're applying the transform to? I haven't seen this issue so there must be some difference between the source I've been testing with and what you have.