<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="../docs.xsl"?>

<docs type="symbol" project="SIEGE" version="0.8.2" rpath="..">
	<file root="siege" name="common.h">
		<group key="Common" name="Common">
			<symbol id="2" kind="type" internal="false" cname="SGchar">
				<index>
					<entry key="char">SGchar</entry>
					<entry key="wchar">SGwchar</entry>
					<entry key="dchar">SGdchar</entry>
				</index>
				<section name="Name">
					<names>
						<name>SGchar</name>
						<name>SGwchar</name>
						<name>SGdchar</name>
						<descr>character types</descr>
					</names>
				</section>
				<section name="Synopsis">
					<code-block lang="C">typedef char <ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGchar</ref>;
typedef ... <ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGwchar</ref>;
typedef ... <ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGdchar</ref>;</code-block>
				</section>
				<section name="Description">
					<p>
						<ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGchar</ref> is defined to the `char` type for conveniency and completeness. <ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGwchar</ref> and <ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGdchar</ref> are defined to unsigned 16-bit and 32-bit types, respectively; they are meant to be used for UTF-16 and UTF-32.
					</p>
				</section>
				<section name="See Also">
					<sees>
						<see><ref local="false" path="." file="common" group="Common" name="SGbool" id="1">SGbool</ref></see>
						<see><ref local="false" path="." file="common" group="Common" name="SGbool" id="1">SGenum</ref></see>
						<see><ref local="false" path="." file="common" group="Common" name="SGbyte" id="3">SGuint</ref></see>
						<see><ref local="false" path="." file="common" group="Common" name="SGfloat" id="4">SGfloat</ref></see>
					</sees>
				</section>
				<section name="TODO">
						<ul>
							<li>
								<p>
									Check for C11 and use `char16_t` / `char32_t` for <ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGwchar</ref> / <ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGdchar</ref> if possible.
								</p>
							</li>
							<li>
								<p>
									(?) Make <ref local="true" path="." file="common" group="Common" name="SGchar" id="2">SGchar</ref> unsigned
								</p>
							</li>
						</ul>
				</section>
			</symbol>
		</group>
	</file>
</docs>
