Commit d321d8a1 authored by Michal Policht's avatar Michal Policht

Autogenerate documentation.

parent 31d59eed
......@@ -178,11 +178,8 @@ H_EXTENSIONS_CUTEHMI_2_INCLUDE_CUTEHMI_INPLACEERROR_HPP</span></div>
<a class="code" href="structcutehmi_1_1_error.html">Error</a></div>
<div class="line"><a name="l00017" id="l00017"></a> <span class=
"lineno">17</span>&nbsp;{</div>
<div class="line"><a name="l00018" id="l00018"></a> <span class=
"lineno">18</span>&nbsp; <span class="comment">// Note: line count
starts with 1.</span></div>
<div class="line"><a name="l00019" id="l00019"></a> <span class=
"lineno">19</span>&nbsp; <a class="code" href=
<div class="line"><a name="l00031" id="l00031"></a> <span class=
"lineno">31</span>&nbsp; <a class="code" href=
"structcutehmi_1_1_inplace_error.html">InplaceError</a>(<span class="keyword">const</span>
<a class="codeRef" doxygen=
"/usr/share/qt5/doc/qtcore/qtcore.tags:http://doc.qt.io/qt-5/"
......@@ -197,90 +194,90 @@ href="http://doc.qt.io/qt-5/qstring.html">QString</a> &amp; message
= <a class="code" href=
"structcutehmi_1_1_error.html#af321daa00c741246e8c9a21ea0435b96a0c6b97356c9b55098ad4a421b1d3956e">
Error::FAIL</a>);</div>
<div class="line"><a name="l00020" id="l00020"></a> <span class=
"lineno">20</span>&nbsp;</div>
<div class="line"><a name="l00021" id="l00021"></a> <span class=
"lineno">21</span>&nbsp; <a class="codeRef" doxygen=
<div class="line"><a name="l00032" id="l00032"></a> <span class=
"lineno">32</span>&nbsp;</div>
<div class="line"><a name="l00037" id="l00037"></a> <span class=
"lineno">37</span>&nbsp; <a class="codeRef" doxygen=
"/usr/share/qt5/doc/qtcore/qtcore.tags:http://doc.qt.io/qt-5/"
href="http://doc.qt.io/qt-5/qstring.html">QString</a> str()
<span class="keyword">const</span>;</div>
<div class="line"><a name="l00022" id="l00022"></a> <span class=
"lineno">22</span>&nbsp;</div>
<div class="line"><a name="l00023" id="l00023"></a> <span class=
<div class="line"><a name="l00038" id="l00038"></a> <span class=
"lineno">38</span>&nbsp;</div>
<div class="line"><a name="l00039" id="l00039"></a> <span class=
"lineno"><a class="line" href=
"structcutehmi_1_1_inplace_error.html#a2e6d4aa27b499a1589bfc93c290c7005">
23</a></span>&nbsp; <a class="codeRef" doxygen=
39</a></span>&nbsp; <a class="codeRef" doxygen=
"/usr/share/qt5/doc/qtcore/qtcore.tags:http://doc.qt.io/qt-5/"
href="http://doc.qt.io/qt-5/qstring.html">QString</a> <a class=
"code" href=
"structcutehmi_1_1_inplace_error.html#a2e6d4aa27b499a1589bfc93c290c7005">
message</a>;</div>
<div class="line"><a name="l00024" id="l00024"></a> <span class=
<div class="line"><a name="l00040" id="l00040"></a> <span class=
"lineno"><a class="line" href=
"structcutehmi_1_1_inplace_error.html#a4310d915668446e302d2279e3f7049d7">
24</a></span>&nbsp; <span class="keyword">const</span> <span class=
40</a></span>&nbsp; <span class="keyword">const</span> <span class=
"keywordtype">char</span> * <a class="code" href=
"structcutehmi_1_1_inplace_error.html#a4310d915668446e302d2279e3f7049d7">
file</a>;</div>
<div class="line"><a name="l00025" id="l00025"></a> <span class=
<div class="line"><a name="l00041" id="l00041"></a> <span class=
"lineno"><a class="line" href=
"structcutehmi_1_1_inplace_error.html#a607b7b35af9e508dccfc6368ebea0070">
25</a></span>&nbsp; <span class="keywordtype">int</span> <a class=
41</a></span>&nbsp; <span class="keywordtype">int</span> <a class=
"code" href=
"structcutehmi_1_1_inplace_error.html#a607b7b35af9e508dccfc6368ebea0070">
line</a>;</div>
<div class="line"><a name="l00026" id="l00026"></a> <span class=
<div class="line"><a name="l00042" id="l00042"></a> <span class=
"lineno"><a class="line" href=
"structcutehmi_1_1_inplace_error.html#a914b724c002f186b1adecbc9d0998c33">
26</a></span>&nbsp; <span class="keyword">const</span> <span class=
42</a></span>&nbsp; <span class="keyword">const</span> <span class=
"keywordtype">char</span> * <span class=
"keyword">function</span>;</div>
<div class="line"><a name="l00027" id="l00027"></a> <span class=
"lineno">27</span>&nbsp;};</div>
<div class="line"><a name="l00028" id="l00028"></a> <span class=
"lineno">28</span>&nbsp;</div>
<div class="line"><a name="l00029" id="l00029"></a> <span class=
"lineno">29</span>&nbsp;}</div>
<div class="line"><a name="l00030" id="l00030"></a> <span class=
"lineno">30</span>&nbsp;</div>
<div class="line"><a name="l00031" id="l00031"></a> <span class=
<div class="line"><a name="l00043" id="l00043"></a> <span class=
"lineno">43</span>&nbsp;};</div>
<div class="line"><a name="l00044" id="l00044"></a> <span class=
"lineno">44</span>&nbsp;</div>
<div class="line"><a name="l00045" id="l00045"></a> <span class=
"lineno">45</span>&nbsp;}</div>
<div class="line"><a name="l00046" id="l00046"></a> <span class=
"lineno">46</span>&nbsp;</div>
<div class="line"><a name="l00047" id="l00047"></a> <span class=
"lineno"><a class="line" href=
"_inplace_error_8hpp.html#aa72cf43028484c42b8b745185978df1f">31</a></span>&nbsp;<span class="preprocessor">#define
"_inplace_error_8hpp.html#aa72cf43028484c42b8b745185978df1f">47</a></span>&nbsp;<span class="preprocessor">#define
CUTEHMI_ERROR(MESSAGE) cutehmi::InplaceError(MESSAGE, __FILE__,
__LINE__, Q_FUNC_INFO)</span></div>
<div class="line"><a name="l00032" id="l00032"></a> <span class=
"lineno">32</span>&nbsp;</div>
<div class="line"><a name="l00033" id="l00033"></a> <span class=
"lineno">33</span>&nbsp;Q_DECLARE_METATYPE(<a class="code" href=
<div class="line"><a name="l00048" id="l00048"></a> <span class=
"lineno">48</span>&nbsp;</div>
<div class="line"><a name="l00049" id="l00049"></a> <span class=
"lineno">49</span>&nbsp;Q_DECLARE_METATYPE(<a class="code" href=
"structcutehmi_1_1_inplace_error.html">cutehmi::InplaceError</a>)</div>
<div class="line"><a name="l00034" id="l00034"></a> <span class=
"lineno">34</span>&nbsp;</div>
<div class="line"><a name="l00035" id="l00035"></a> <span class=
"lineno">35</span>&nbsp;<span class=
<div class="line"><a name="l00050" id="l00050"></a> <span class=
"lineno">50</span>&nbsp;</div>
<div class="line"><a name="l00051" id="l00051"></a> <span class=
"lineno">51</span>&nbsp;<span class=
"preprocessor">#endif</span></div>
<div class="line"><a name="l00036" id="l00036"></a> <span class=
"lineno">36</span>&nbsp;</div>
<div class="line"><a name="l00037" id="l00037"></a> <span class=
"lineno">37</span>&nbsp;<span class="comment">//(c)MP: Copyright ©
<div class="line"><a name="l00052" id="l00052"></a> <span class=
"lineno">52</span>&nbsp;</div>
<div class="line"><a name="l00053" id="l00053"></a> <span class=
"lineno">53</span>&nbsp;<span class="comment">//(c)MP: Copyright ©
2019, Michal Policht &lt;michpolicht@gmail.com&gt;. All rights
reserved.</span></div>
<div class="line"><a name="l00038" id="l00038"></a> <span class=
"lineno">38</span>&nbsp;<span class="comment">//(c)MP: This file is
<div class="line"><a name="l00054" id="l00054"></a> <span class=
"lineno">54</span>&nbsp;<span class="comment">//(c)MP: This file is
a part of CuteHMI.</span></div>
<div class="line"><a name="l00039" id="l00039"></a> <span class=
"lineno">39</span>&nbsp;<span class="comment">//(c)MP: CuteHMI is
<div class="line"><a name="l00055" id="l00055"></a> <span class=
"lineno">55</span>&nbsp;<span class="comment">//(c)MP: CuteHMI is
free software: you can redistribute it and/or modify it under the
terms of the GNU Lesser General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at
your option) any later version.</span></div>
<div class="line"><a name="l00040" id="l00040"></a> <span class=
"lineno">40</span>&nbsp;<span class="comment">//(c)MP: CuteHMI is
<div class="line"><a name="l00056" id="l00056"></a> <span class=
"lineno">56</span>&nbsp;<span class="comment">//(c)MP: CuteHMI is
distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.</span></div>
<div class="line"><a name="l00041" id="l00041"></a> <span class=
"lineno">41</span>&nbsp;<span class="comment">//(c)MP: You should
<div class="line"><a name="l00057" id="l00057"></a> <span class=
"lineno">57</span>&nbsp;<span class="comment">//(c)MP: You should
have received a copy of the GNU Lesser General Public License along
with CuteHMI. If not, see
&lt;https://www.gnu.org/licenses/&gt;.</span></div>
......@@ -309,7 +306,7 @@ with CuteHMI. If not, see
"structcutehmi_1_1_inplace_error.html#a607b7b35af9e508dccfc6368ebea0070">
cutehmi::InplaceError::line</a></div>
<div class="ttdeci">int line</div>
<div class="ttdef"><b>Definition:</b> InplaceError.hpp:25</div>
<div class="ttdef"><b>Definition:</b> InplaceError.hpp:41</div>
</div>
<div class="ttc" id="namespacecutehmi_html">
<div class="ttname"><a href=
......@@ -332,7 +329,7 @@ cutehmi::InplaceError::line</a></div>
"structcutehmi_1_1_inplace_error.html#a2e6d4aa27b499a1589bfc93c290c7005">
cutehmi::InplaceError::message</a></div>
<div class="ttdeci">QString message</div>
<div class="ttdef"><b>Definition:</b> InplaceError.hpp:23</div>
<div class="ttdef"><b>Definition:</b> InplaceError.hpp:39</div>
</div>
<div class="ttc" id=
"structcutehmi_1_1_inplace_error_html_a4310d915668446e302d2279e3f7049d7">
......@@ -340,7 +337,7 @@ cutehmi::InplaceError::message</a></div>
"structcutehmi_1_1_inplace_error.html#a4310d915668446e302d2279e3f7049d7">
cutehmi::InplaceError::file</a></div>
<div class="ttdeci">const char * file</div>
<div class="ttdef"><b>Definition:</b> InplaceError.hpp:24</div>
<div class="ttdef"><b>Definition:</b> InplaceError.hpp:40</div>
</div>
<div class="ttc" id=
"structcutehmi_1_1_error_html_af321daa00c741246e8c9a21ea0435b96a0c6b97356c9b55098ad4a421b1d3956e">
......
......@@ -161,6 +161,8 @@ connections.</p>
uses PImpl idiom to maintain binary compatibility.</p>
<p><a class="el" href="structcutehmi_1_1_error.html" title=
"Standarized error. ">cutehmi::Error</a>, <a class="el" href=
"structcutehmi_1_1_inplace_error.html" title=
"In-place error. ">cutehmi::InplaceError</a>, <a class="el" href=
"structcutehmi_1_1_error_info.html" title=
"Error info. ">cutehmi::ErrorInfo</a>, <a class="el" href=
"classcutehmi_1_1_exception.html" title=
......
......@@ -188,6 +188,11 @@ int <a class="el" href=
href=
"structcutehmi_1_1_error.html#af321daa00c741246e8c9a21ea0435b96a0c6b97356c9b55098ad4a421b1d3956e">Error::FAIL</a>)</td>
</tr>
<tr class="memdesc:a48ce1fd4966dd5ab7e721ec1f6079894">
<td class="mdescLeft">&nbsp;</td>
<td class="mdescRight">Constructor. <a href=
"#a48ce1fd4966dd5ab7e721ec1f6079894">More...</a><br /></td>
</tr>
<tr class="separator:a48ce1fd4966dd5ab7e721ec1f6079894">
<td class="memSeparator" colspan="2">&nbsp;</td>
</tr>
......@@ -200,6 +205,11 @@ href="http://doc.qt.io/qt-5/qstring.html">QString</a>&nbsp;</td>
"structcutehmi_1_1_inplace_error.html#a0066a218e442df9f2f46a052f13156c3">
str</a> () const</td>
</tr>
<tr class="memdesc:a0066a218e442df9f2f46a052f13156c3">
<td class="mdescLeft">&nbsp;</td>
<td class="mdescRight">Get error string. <a href=
"#a0066a218e442df9f2f46a052f13156c3">More...</a><br /></td>
</tr>
<tr class="separator:a0066a218e442df9f2f46a052f13156c3">
<td class="memSeparator" colspan="2">&nbsp;</td>
</tr>
......@@ -433,6 +443,8 @@ inherited from <a class="el" href=
<h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>In-place error.</p>
<p>This class can be more conveniently used with CUTEHMI_ERROR
macro.</p>
<dl class="section remark">
<dt>Remarks</dt>
<dd>This class is registered as metatype by <a class="el" href=
......@@ -494,7 +506,43 @@ Error::FAIL</a></code>&nbsp;</td>
</tr>
</table>
</div>
<div class="memdoc"></div>
<div class="memdoc">
<p>Constructor.</p>
<dl class="params">
<dt>Parameters</dt>
<dd>
<table class="params">
<tr>
<td class="paramname">message</td>
<td>error message.</td>
</tr>
<tr>
<td class="paramname">file</td>
<td>file name, where error occurred.</td>
</tr>
<tr>
<td class="paramname">line</td>
<td>line at which error occurred.</td>
</tr>
<tr>
<td class="paramname">function</td>
<td>function inside which error occurred.</td>
</tr>
<tr>
<td class="paramname">code</td>
<td>error code.</td>
</tr>
</table>
</dd>
</dl>
<dl class="section note">
<dt>Note</dt>
<dd>It is not intended to use this constructor directly. To
conveniently create an instance of this class a CUTEHMI_ERROR
macro, which takes only message as an argument, should be
used.</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0066a218e442df9f2f46a052f13156c3" name=
......@@ -516,7 +564,13 @@ cutehmi::InplaceError::str</td>
</tr>
</table>
</div>
<div class="memdoc"></div>
<div class="memdoc">
<p>Get error string.</p>
<dl class="section return">
<dt>Returns</dt>
<dd>error string.</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4310d915668446e302d2279e3f7049d7" name=
......
......@@ -135,35 +135,44 @@ they can be also used like standard libraries.</p>
used to boost the process of creating custom extensions.</p>
<h2>Directories</h2>
<p>Directory structure of extensions follows standard QML
extensions scheme. Directory name of the extension defines fully
qualified extension <b>name</b> denoted as
<b>VendorName.ExtensionName.MajorVersion</b>. As a reference we can
take <code>Templates.Skeleton.0</code> extension.</p>
<p>Fully qualified <b>name</b> consists of <b>base name</b>
(<code>Templates.Skeleton</code>) and <b>major version suffix</b>
(<code>.0</code>). <b>Base name</b> consists of two parts:
<b>vendor name</b> (<code>Templates</code>) and <b>extension
name</b> (<code>Skeleton</code>). It is allowed to omit
<b>extension name</b> for a single extension from a specific
vendor.</p>
extensions scheme. According to <a href=
"https://doc.qt.io/qt-5/qtqml-modules-identifiedmodules.html#semantics-of-identified-modules">
QML identified module rules</a> path of an extension relative to
<code>extensions</code> directory defines module identifier, which
is also extension <b>name</b> denoted as
<b>BaseName.MajorVersion</b>. Typically <b>BaseName</b> consists of
dot-separated <em>VendorName.ExtensionName</em> parts, but this is
a convention rather than a requirement. Extension name must only
contain <b>base name</b> and <b>major version</b> suffix. Base name
parts have no special meaning.</p>
<p>As a reference we can take <code>Templates.Skeleton.0</code>
extension. Fully qualified <b>name</b> consists of <b>base name</b>
(<code>Templates.Skeleton</code>) and <b>major version</b> suffix
(<code>0</code>). <b>Base name</b> consists of two parts:
<em>vendor name</em> (<code>Templates</code>) and <em>extension
name</em> (<code>Skeleton</code>). It is allowed to omit
<em>extension name</em> for a single extension from a specific
vendor. It is also allowed to provide dot-separated <em>extension
name</em> (e.g. <code>examples.Skeleton</code>); or do the same
with <em>vendor</em> (e.g. <code>org.nokia</code>).</p>
<p>Extension directories follow camel-case (PascalCase) rules in
order to remain consistent with QML extension naming convention
used by Qt. On the other hand following this convention within C++
would be inconvenient in many places, so compromises have been
made. Sometimes semantic members of extension directory name are
lowercased. To express such intention, a pattern
<b>VendorName.ExtensionName.MajorVersion</b> will be transformed
according to the intention (i.e. <b>vendorname</b> represents
lowercased <b>VendorName</b>).</p>
<em>VendorName.ExtensionName.MajorVersion</em> will be transformed
according to the intention (i.e. <em>vendorname</em> represents
lowercased <em>VendorName</em>).</p>
<p>Typically each extension will have directory structure similar
to this one.</p>
<ul>
<li><code>include</code> - public header files (available to other
modules).
<ul>
<li><b>vendorname</b> - for example <code>templates</code>.
<li><em>vendorname</em> - for example <code>templates</code>.
<ul>
<li><b>extensionname</b> - for example <code>skeleton</code>.
<li><em>extensionname</em> - for example <code>skeleton</code>.
<ul>
<li><code>internal</code> - some headers need to be publicly
available, but they are implementation detail. This directory is
......@@ -176,9 +185,9 @@ for such files.</li>
</li>
<li><code>src</code> - private header files and implementation.
<ul>
<li><b>vendorname</b> - for example <code>templates</code>.
<li><em>vendorname</em> - for example <code>templates</code>.
<ul>
<li><b>extensionname</b> - for example <code>skeleton</code>.
<li><em>extensionname</em> - for example <code>skeleton</code>.
<ul>
<li><code>internal</code> - corresponds with <code>internal</code>
subdirectory inside <code>include</code> directory.</li>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment