[Doxygen-users] xmlonly tag (was: Adding my very own XML tags to doxygen's output?)

[Rod O. <oll...@se...>]

so:
<para>This is Foo, a model of  \xmlonly <model> \endxmlonly Bar \xmlonly </model> \endxmlonly </para>

will produce the HTML:
<p>This is Foo, a model of  Bar</p>

and the XML:
<para>This is Foo, a model of  <model> Bar</model></para>

It sounds a great tag, Dimitri, convenient exactly to Uwe's request.

"I want to embed my own XML elements in the documentation, which shall be preserved in the XML output, but may be ignored in other modes"

Cheers,
Rod

(hitting reply-all and deleting the single recipient)


Dimitri van Heesch wrote:

> On Tue, May 27, 2003 at 03:03:28PM -0700, Uwe Behrens wrote:
> > Hi group!
> >
> > I have asked this question earlier already, but unfortunately received no usable response.
> >
> > Is it possible to add the ability to process custom XML tags to doxygen's XML backend? I want to embed my own XML elements in the documentation, which shall be preserved in the XML output, but may be ignored in other modes (since they have no predefined 'meaning' there). Here's an example:
> >
> >       //! \brief This is Foo, a model of <model>Bar</model>
> >       struct Foo {
> >
> >               // ...
> >
> >       };
> >
> > Then in the HTML/LaTeX/RTF/man output, the <model> element will be suppressed, since there is no way to interpret it:
> >
> >       <p>This is Foo, a model of Bar</p>
> >
> > However, in the XML output, it will be preserved:
> >
> >       <para>This is Foo, a model of <model>Bar</model></para>
> >
> > Of course, the default DTD etc. no longer applies, but I still
> > think this is a very useful feature (I know it is exactly what I need
> > right now!).  Also, there is no need to use standard XML/HTML syntax for
> > this, a doxygen style syntax like the following would be just as useful,
> > and may be easier to implement:
> >
> >       //! This is Foo, a model of \xmltagbegin model Bar \xmltagend
> >
> > Are there any plans to add something like this?  Or is this already possible, and I am just too dumb to find it?  Or can somebody point me in the direction of how to do that myself?
>
> This is not possible at the moment, and adding it with XML/HTML syntax would
> avoid any tag checking for the other output formats (since any unknown tags
> have to be ignored, so also tags whose name is a typo), so I'm not a big fan
> of adding that. One could easily add a \xmlonly ... \endxmlonly
> block (as is available for the other formats) in which you could put
> the <model> tag, but I realise this may be less convenient/pretty.
>
> Regards,
>   Dimitri
>
> -------------------------------------------------------
> This SF.net email is sponsored by: ObjectStore.
> If flattening out C++ or Java code to make your application fit in a
> relational database is painful, don't do it! Check out ObjectStore.
> Now part of Progress Software. http://www.objectstore.net/sourceforge
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users