[ xframe-Bugs-978539 ] Some annotations lost

Bugs item #978539, was opened at 2004-06-23 17:11
Message generated for change (Comment added) made by mdiggory
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=454391&aid=978539&group_id=48863

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: XML
Group: xsddoc-0.5-beta
Status: Closed
Resolution: Fixed
Priority: 5
Submitted By: Nobody/Anonymous (nobody)
Assigned to: Kurt Riede (kriede)
Summary: Some annotations lost

Initial Comment:
Hello,

I have a case of annotation/documentation that doesn't
end up into the HTML documentation.  But I'm not sure
if it's a bug or not...

Here is a sample case:
  <xs:element name="AnElement">
    <xs:annotation>
      <xs:documentation>
This gets into the HTML doc
      </xs:documentation>
    </xs:annotation>
    <xs:complexType>
      <xs:attributeGroup ref="aReferenceToAGroup"/>
      <xs:attributeGroup ref="aReferenceToAnotherGroup">
        <xs:annotation>
          <xs:documentation>
            <html:br/>
This doesn't end up into the HTML doc
            <html:br/>
          </xs:documentation>
        </xs:annotation>
      </xs:attributeGroup>
    </xs:complexType>
  </xs:element>

What I wanted to do is to provide documentation of a
particular instance of the "aReferenceToAnotherGroup"
within the "AnElement" element.  But I'm not even sure
I can do that in the present output format of the HTML
documentation - I have no idea where that could end up!

Thanks,
   Di.

----------------------------------------------------------------------

Comment By: Mark Diggory (mdiggory)
Date: 2005-08-30 10:30

Message:
Logged In: YES 
user_id=208348

Seems logical that you would place this documentation in the
page next to the element definition as that is the point
that the annotation is local...

----------------------------------------------------------------------

Comment By: Kurt Riede (kriede)
Date: 2004-06-25 09:44

Message:
Logged In: YES 
user_id=484961

Thanx for your report.
This is an interesting and important question:
Currently, not all documentations are available in the output 
of xsddoc.
In your case, our decision was: a group is a generic 
component and should be documented in the group definition, 
not in the reference.
But in general you are somehow right: There are always good 
reasons for additional local declarations.
So a more general question to be answered is: Should we 
ensure to have ALL documentation tags in the xsddoc 
documentation, or if not, which should be present.
Give us some time to analyse this question.
Any help would be appreciated.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=454391&aid=978539&group_id=48863


-------------------------------------------------------
SF.Net email is Sponsored by the Better Software Conference & EXPO
September 19-22, 2005 * San Francisco, CA * Development Lifecycle Practices
Agile & Plan-Driven Development * Managing Projects & Teams * Testing & QA
Security * Process Improvement & Measurement * http://www.sqe.com/bsce5sf