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

Include descriptions from schema files #537

Open
t-sommer opened this Issue Feb 19, 2019 · 0 comments

Comments

Projects
None yet
2 participants
@t-sommer
Copy link
Collaborator

t-sommer commented Feb 19, 2019

AsciiDoc allows the inclusion of sections of XML using tags.

It would make sense to synchronize the description in the XSD schema files with the current documentation and include the text into the documentation so we have a "single source of truth" (see also #464).

Example: add a tag to the schema file...

<xs:element name="Binary">
  <xs:attribute name="maxSize" type="xs:nonNegativeInteger" use="optional">
    <xs:annotation>
      <xs:documentation><!-- tag::BinaryMaxSize[] -->If present, limits the maximum size of the binary to the indicated value. All variable accesses, both getting and setting of values must guarantee that the returned size of the binary is strictly equal or less than this maximum size.<!-- end::BinaryMaxSize[] --></xs:documentation>
    </xs:annotation>
  </xs:attribute>
</xs:element>

... and include it in the documentation

== Element <Binary>

=== Attribute maxSize

include::fmi3Variable.xsd[tag=BinaryMaxSize]

@chrbertsch chrbertsch added the CI label Mar 10, 2019

@chrbertsch chrbertsch added this to the v3.0 milestone Mar 10, 2019

@t-sommer t-sommer added the needs poll label Mar 12, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.