55 lines
2.2 KiB
Text
55 lines
2.2 KiB
Text
/**
|
|
\mainpage \productname API Documentation
|
|
|
|
\htmlonly
|
|
<SCRIPT language="JavaScript">
|
|
<!--
|
|
var browserName=navigator.appName;
|
|
var mypath=location.pathname;
|
|
var patt=mypath.match(/.*\/Detection\/$/gi);
|
|
|
|
{
|
|
if (browserName=="Microsoft Internet Explorer") {
|
|
if (patt==mypath)
|
|
{
|
|
window.location="IE/index.html";
|
|
}
|
|
}
|
|
} //--> </SCRIPT>
|
|
\endhtmlonly
|
|
|
|
\section welcome Welcome!
|
|
|
|
This is the \productname API documentation. It details the API for the system
|
|
detection satellite service of Gear 4, which provides information on a PC's
|
|
audio, CPU, disk, graphics, hardware, memory, network, and other system components.
|
|
The table of contents, on the left, provides greater detail in surveying the
|
|
documentation hierarchy down to page-level sections. The search box in the upper
|
|
right corner allows for easier access to specifically named syntatically elements
|
|
in Gear.
|
|
|
|
\note We use Camel case (normally upper Camel case) for all our class and
|
|
function names. Modules and namespaces should be lower Camel case.
|
|
|
|
\remark Despite our honest efforts, sometimes errors and omissions result from
|
|
missing or incorrect tagging or general configuration issues with our API doc
|
|
tool, Doxygen. Please let us know if you spot any missing pages, broken links,
|
|
or other issues.
|
|
|
|
\warning The Webhelp version of this documentation should include SVG files,
|
|
which are not compatible with IE 8 and earlier versions. For optimal viewing,
|
|
we recommend using another browser, such as Chrome, or a newer version of IE.
|
|
|
|
The footer of each page has a reminder that Gear is Ubisoft's own framework and,
|
|
as such, cannot be shared outside of Ubisoft. It also has a support link, where
|
|
you can help us by sending an email about significant issues you may notice
|
|
with either the code or the documentation thereof.
|
|
|
|
<!-- Keep this! It's hidden so nothing shows up; however, without it these images
|
|
- called by the CSS and footer - will not be put into the generated folder. -->
|
|
<div class="hidden">\image html securitytag.png</div>
|
|
<div class="hidden">\image html alertIcon.png</div>
|
|
<div class="hidden">\image html noteIcon.png</div>
|
|
<div class="hidden">\image html attentionIcon.png</div>
|
|
<div class="hidden">\image html tipIcon.png</div>
|
|
*/
|