annotation in generated documentation

[anyujakatash]

I wanted to add a pointer to documentation to the schema, like this:
<annotation>
<documentation source="http://www.myDocs.org/myDoc.html" />
</annotation>

So when you are reading the generated documentation, you can click a
link and read all you want without cluttering the schema with
paragraph length comments.

This validates. However when I use the oXygen documentation generation
feature, Tools->Documentation->Schema Documentation,
to generate what they say is similar to JavaDoc, I get the same thing
whether I check the box that says "Hide annotations" or not, that is,
a nice looking html page in which no annotations appear in the
documentation. In fact, I don't see any way to influence the generated documentation at all.

Anybody have any experience with this and know what I might be doing
wrong or whether this feature works?

[george]

Hi,

The schema documentation processes only the content of the annotations. I will add an enhanement request on our issue tracking to add support for using also the source and eventually link to that.

Best Regards,
George

[anyujakatash]

Thank you, George! I think this would be a great feature and make the generated documentation far more useful. But then what does the "Hide annotations" checkbox do? And how does the documentatinon generator process the content of annotations? The content seems to be ignored.

[george]

The Hide Annotations checkbox is in the Schema Diagrams section so it applies to diagrams. When enabled no annotations will appear in the diagrams while when it is disabled the annotations will appear in the diagrams.

Best Regards,
George

[sorin_ristache]

Hello,

I just wanted to let you know that we implemented the correct handling in the new implementation of the XML Schema documentation tool that we develop and that will be available starting with Oxygen version 10.1. In the generated HTML documentation of the XML Schema the source attribute will be translated as a link to the URL specified in the attribute.


Regards,
Sorin