Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / tinyxml / c3bbea3c3cfee4908189a57b3fc54f105b78c59b / . / docs / classTiXmlComment.html
blob: e202443077ff4930d7144202f8e9d5f67aa8ef1f [file] [log] [blame]
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]5<title>TinyXml: TiXmlComment Class Reference</title>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]6<link href="tabs.css" rel="stylesheet" type="text/css"/>
7<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8</head>
9<body>
10<!-- Generated by Doxygen 1.6.2 -->
11<div class="navigation" id="top">
12 <div class="tabs">
13 <ul>
14 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15 <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
17 <li><a href="files.html"><span>Files</span></a></li>
18 </ul>
19 </div>
20 <div class="tabs">
21 <ul>
22 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25 </ul>
26 </div>
27</div>
28<div class="contents">
29<h1>TiXmlComment Class Reference</h1><!-- doxytag: class="TiXmlComment" --><!-- doxytag: inherits="TiXmlNode" -->
30<p>An XML comment.
31<a href="#_details">More...</a></p>
32
33<p><code>#include &lt;<a class="el" href="tinyxml_8h_source.html">tinyxml.h</a>&gt;</code></p>
34<div class="dynheader">
35Inheritance diagram for TiXmlComment:</div>
36<div class="dynsection">
37 <div class="center">
38 <img src="classTiXmlComment.png" usemap="#TiXmlComment_map" alt=""/>
39 <map id="TiXmlComment_map" name="TiXmlComment_map">
40<area href="classTiXmlNode.html" alt="TiXmlNode" shape="rect" coords="0,56,94,80"/>
41<area href="classTiXmlBase.html" alt="TiXmlBase" shape="rect" coords="0,0,94,24"/>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]42</map>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]43 </div>
44</div>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]45
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]46<p><a href="classTiXmlComment-members.html">List of all members.</a></p>
47<table border="0" cellpadding="0" cellspacing="0">
48<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
49<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa3252031d3e8bd3a2bf51a1c61201b7"></a><!-- doxytag: member="TiXmlComment::TiXmlComment" ref="aaa3252031d3e8bd3a2bf51a1c61201b7" args="()" -->
50&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#aaa3252031d3e8bd3a2bf51a1c61201b7">TiXmlComment</a> ()</td></tr>
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs an empty comment. <br/></td></tr>
52<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37e7802ef17bc03ebe5ae79bf0713d47"></a><!-- doxytag: member="TiXmlComment::TiXmlComment" ref="a37e7802ef17bc03ebe5ae79bf0713d47" args="(const char *_value)" -->
53&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a37e7802ef17bc03ebe5ae79bf0713d47">TiXmlComment</a> (const char *_value)</td></tr>
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a comment from text. <br/></td></tr>
55<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d6662bdc52488b9e12b3c7a0453d028"></a><!-- doxytag: member="TiXmlComment::Clone" ref="a0d6662bdc52488b9e12b3c7a0453d028" args="() const " -->
56virtual <a class="el" href="classTiXmlNode.html">TiXmlNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a0d6662bdc52488b9e12b3c7a0453d028">Clone</a> () const </td></tr>
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a copy of this Comment. <br/></td></tr>
58<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a6b316527aaa8da0370cd68c22a5a0f5f">Print</a> (FILE *cfile, int depth) const </td></tr>
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. <a href="#a6b316527aaa8da0370cd68c22a5a0f5f"></a><br/></td></tr>
60<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00fb4215c20a2399ea05ac9b9e7e68a0"></a><!-- doxytag: member="TiXmlComment::ToComment" ref="a00fb4215c20a2399ea05ac9b9e7e68a0" args="() const " -->
61virtual const <a class="el" href="classTiXmlComment.html">TiXmlComment</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#a00fb4215c20a2399ea05ac9b9e7e68a0">ToComment</a> () const </td></tr>
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cast to a more defined type. Will return null not of the requested type. <br/></td></tr>
63<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc7c7e07e13c23f17797d642981511df"></a><!-- doxytag: member="TiXmlComment::ToComment" ref="acc7c7e07e13c23f17797d642981511df" args="()" -->
64virtual <a class="el" href="classTiXmlComment.html">TiXmlComment</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#acc7c7e07e13c23f17797d642981511df">ToComment</a> ()</td></tr>
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cast to a more defined type. Will return null not of the requested type. <br/></td></tr>
66<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3ac1b99fbbe9ea4fb6e14146156e43e"></a><!-- doxytag: member="TiXmlComment::Accept" ref="af3ac1b99fbbe9ea4fb6e14146156e43e" args="(TiXmlVisitor *visitor) const " -->
67virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTiXmlComment.html#af3ac1b99fbbe9ea4fb6e14146156e43e">Accept</a> (<a class="el" href="classTiXmlVisitor.html">TiXmlVisitor</a> *visitor) const </td></tr>
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Walk the XML tree visiting this node and all of its children. <br/></td></tr>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]69</table>
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]70<hr/><a name="_details"></a><h2>Detailed Description</h2>
71<p>An XML comment. </p>
72<hr/><h2>Member Function Documentation</h2>
73<a class="anchor" id="a6b316527aaa8da0370cd68c22a5a0f5f"></a><!-- doxytag: member="TiXmlComment::Print" ref="a6b316527aaa8da0370cd68c22a5a0f5f" args="(FILE *cfile, int depth) const " -->
74<div class="memitem">
75<div class="memproto">
76 <table class="memname">
77 <tr>
78 <td class="memname">virtual void TiXmlComment::Print </td>
79 <td>(</td>
80 <td class="paramtype">FILE *&nbsp;</td>
81 <td class="paramname"> <em>cfile</em>, </td>
82 </tr>
83 <tr>
84 <td class="paramkey"></td>
85 <td></td>
86 <td class="paramtype">int&nbsp;</td>
87 <td class="paramname"> <em>depth</em></td><td>&nbsp;</td>
88 </tr>
89 <tr>
90 <td></td>
91 <td>)</td>
92 <td></td><td></td><td> const<code> [virtual]</code></td>
93 </tr>
94 </table>
95</div>
96<div class="memdoc">
97
98<p>All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. </p>
99<p>) Either or both cfile and str can be null.</p>
100<p>This is a formatted print, and will insert tabs and newlines.</p>
101<p>(For an unformatted stream, use the &lt;&lt; operator.) </p>
102
103<p>Implements <a class="el" href="classTiXmlBase.html#a0de56b3f2ef14c65091a3b916437b512">TiXmlBase</a>.</p>
104
105</div>
106</div>
107<hr/>The documentation for this class was generated from the following file:<ul>
108<li><a class="el" href="tinyxml_8h_source.html">tinyxml.h</a></li>
109</ul>
110</div>
111<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]112<a href="http://www.doxygen.org/index.html">
Dan Albertc3bbea32014-08-21 15:48:37 -0700[diff] [blame^]113<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
The Android Open Source Project562be062009-03-03 19:30:48 -0800[diff] [blame]114</body>
115</html>