[xsd-users] Tool for documenting/visualizing C++ Tree Output

[Iain Sharp]

Thanks - with a bit of tweaking of parameters I was able to get good output from Doxygen.

Just one question: even if I include the headers from XSD tree in the Doxygen input I still get output like:

typedef ::xsd::cxx::tree::optional< App_ID_type > 	App_ID_optional
 	Element optional container type.

App_ID_optional & 	App_ID ()
 	Return a read-write reference to the element container. More...

In this example, the App_ID_optional isn't documented except as an instance of the templated type which itself doesn't seem to appear in the Doxygen output. 

Is there a way to add some documentation for common templated types like optional etc. to the output?

Regards

Iain


-----Original Message-----
From: Boris Kolpackov [mailto:boris at codesynthesis.com] 
Sent: 08 December 2017 08:10
To: Iain Sharp <isharp at atis.org>
Cc: xsd-users at codesynthesis.com
Subject: Re: [xsd-users] Tool for documenting/visualizing C++ Tree Output

Iain Sharp <isharp at atis.org> writes:

> Are there any tools that can automatically provide high-level diagrams 
> of the classes and the available methods? I guess the obvious thing is 
> to try doxygen [...]

Yes, Doxygen (--generate-doxygen option) is your best bet. You will even have the documentation from the schema copied over. You can see an example of what it looks like here:

https://www.codesynthesis.com/projects/xsd/documentation/cxx/tree/hello/html/annotated.html

For more information on Doxygen support in C++/Tree, see Section 2.7 "Generating Documentation" in the C++/Tree Mapping Getting Started
Guide:

https://www.codesynthesis.com/projects/xsd/documentation/cxx/tree/guide/#2.7

Boris