On May 13, 2011, at 1:14 PM, Dimitri Van Heesch wrote:
>> What is the best way to let Doxygen know I want "<myTagName>" to be part of the documentation output?
>
> >Just escape the < and > like this \<myTagName\> or if you want the quotes as well then
> you don't even need to escape, so "<myTagName>" will also work.
Thank you Dimitri. Escaping is much easier on my typing fingers. :-)
However I can not seem to escape warnings when including an xml file. perhaps the TK_EOF warning is the main clue?
Document source:
-------------------------
Seen in the example below are three collection types:
-# \ref workstations
-# \ref videoSourcesCollection
-# \ref subscriptionPackagesCollection
\include configuration.xml.txt
<hr><b>
\section secpageSequenceDiagramRefs References
</b>
Include Source:
---------------------
<?xml version="1.0" encoding="utf-8"?>
<!--
*********************************************************************************************
File: configuration.xml
*********************************************************************************************
-->
<configuration>
<videoSources>
<!-- The use of bmp file in the uri is for development purposes only; to display images of arbitray resolutions at a fixed 5 fps. -->
<!-- Comment-out
<videoSource>
<name>SMPTE Color Bars (Still image)</name>
<uri>file:///usr/share/fesvideodisplay/vsu/fes-smpte-ColorBars.bmp</uri>
</videoSource> -->
</videoSources>
<!-- ************************************************** -->
<!-- subscriptionPackages - collections of videoSources -->
<!-- ************************************************** -->
<subscriptionPackages>
<!-- A subscriptionPackage may be used to define a collection of Subscription's to VideoSource's. -->
<subscriptionPackage>
<name>Default</name>
<subscriptions>
<!-- Comment-out colorbars
<subscription>
<videoSource>SMPTE Color Bars Bitmap (No decode)</videoSource>
<active>false</active>
</subscription> -->
</subscriptions>
</subscriptionPackage>
</subscriptionPackages>
<!-- ***************************************************** -->
<!-- applicationSettings - application-specific settings -->
<!-- ***************************************************** -->
<applicationSettings>
<caption>Camera Diagnostics Video Display HCM</caption>
<decoder>
<!-- For better performance, set to max supported value of 4 on quad or dual-quad Intel CPUs -->
<!-- Overall CPU usage is expected to be lower when set to max supported value of 4. -->
<maxThreads>4</maxThreads>
</decoder>
<networking>
<!-- Optional (for debug and test, Defaults to ttl=255 -->
<multicastTtl>255</multicastTtl>
<!-- Optional (for debug and test, Defaults to false -->
<multicastLoopEnabled>true</multicastLoopEnabled>
</networking>
<!-- *************************************************************************************** -->
<!-- videoSelectionStatus - Configuration for periodic multicast of video selection status. -->
<!-- *************************************************************************************** -->
<videoSelectionStatus>
<!-- The multicast address and port to send video selection status. -->
<uri>udp://239.255.255.61:50174</uri>
<!-- Optional, Defaults to true -->
<enabled>true</enabled>
<!-- Optional, Defaults to using the IP address specified in the FesVideo constructor.
<ethernet>bond0</ethernet>
-->
<!-- Optional, Defaults to 5 seconds -->
<updateRateSeconds>1</updateRateSeconds>
</videoSelectionStatus>
</applicationSettings>
</configuration>
Resulting Warnings:
----------------------------
/home/esutton/projects/HCM_VideoAPI/libfesvideo/doc-src/api/pageConfiguration.doc:153: warning: unexpected token TK_EOF as the argument of ref
Generating docs for page pageSequenceDiagramConnect...
Generating docs for page pageExampleConfiguration...
/home/esutton/projects/HCM_VideoAPI/libfesvideo/doc-src/api/pageExampleConfiguration.doc:15: warning: Unsupported xml/html tag <subscriptionPackages> found
/home/esutton/projects/HCM_VideoAPI/libfesvideo/doc-src/api/pageExampleConfiguration.doc:18: warning: Unsupported xml/html tag <workstations> found
/home/esutton/projects/HCM_VideoAPI/libfesvideo/doc-src/api/pageExampleConfiguration.doc:19: warning: Unsupported xml/html tag <videoSources> found
/home/esutton/projects/HCM_VideoAPI/libfesvideo/doc-src/api/pageExampleConfiguration.doc:20: warning: Unsupported xml/html tag <subscriptionPackages> found
-Ed
-Ed
>
> Regards,
> Dimitri
>
-Ed
|
