Skip to content

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

Description

@amantalwar04

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions