mirror of
https://github.com/arcan1s/arcanis.me.git
synced 2025-11-03 23:33:41 +00:00
240 lines
13 KiB
HTML
240 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.7"/>
|
|
<title>reportabug: GithubModule Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">reportabug
|
|
</div>
|
|
<div id="projectbrief">Qt application which allows users to create an issue for GitHub projects</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.7 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-slots">Public Slots</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_github_module-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">GithubModule Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The <a class="el" href="class_github_module.html" title="The GithubModule class creates issue over GitHub. ">GithubModule</a> class creates issue over GitHub.
|
|
<a href="class_github_module.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for GithubModule:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_github_module.png" usemap="#GithubModule_map" alt=""/>
|
|
<map id="GithubModule_map" name="GithubModule_map">
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
|
|
Public Slots</h2></td></tr>
|
|
<tr class="memitem:a370fdede5483d2ad4c229a646e70dd93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_github_module.html#a370fdede5483d2ad4c229a646e70dd93">sendReportUsingGithub</a> (const QMap< QString, QString > info)</td></tr>
|
|
<tr class="memdesc:a370fdede5483d2ad4c229a646e70dd93"><td class="mdescLeft"> </td><td class="mdescRight">method which creates an issue <a href="#a370fdede5483d2ad4c229a646e70dd93">More...</a><br /></td></tr>
|
|
<tr class="separator:a370fdede5483d2ad4c229a646e70dd93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:adc2325a4e86e2379e8ef4353ff00f3bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_github_module.html#adc2325a4e86e2379e8ef4353ff00f3bb">GithubModule</a> (QWidget *parent=0, bool debugCmd=false, QMap< QString, QString > params=QMap< QString, QString >())</td></tr>
|
|
<tr class="memdesc:adc2325a4e86e2379e8ef4353ff00f3bb"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_github_module.html" title="The GithubModule class creates issue over GitHub. ">GithubModule</a> class constructor. <a href="#adc2325a4e86e2379e8ef4353ff00f3bb">More...</a><br /></td></tr>
|
|
<tr class="separator:adc2325a4e86e2379e8ef4353ff00f3bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4216f8b9eb88ce568707df157b1b5fd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_github_module.html#aa4216f8b9eb88ce568707df157b1b5fd">~GithubModule</a> ()</td></tr>
|
|
<tr class="memdesc:aa4216f8b9eb88ce568707df157b1b5fd"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_github_module.html" title="The GithubModule class creates issue over GitHub. ">GithubModule</a> class destructor. <a href="#aa4216f8b9eb88ce568707df157b1b5fd">More...</a><br /></td></tr>
|
|
<tr class="separator:aa4216f8b9eb88ce568707df157b1b5fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The <a class="el" href="class_github_module.html" title="The GithubModule class creates issue over GitHub. ">GithubModule</a> class creates issue over GitHub. </p>
|
|
<p>The GitHub API is used for creating issue. Please visit <a href="https://developer.github.com/v3/issues/">the API page</a> for more details. This module requires an users authentication. The typical POST request is: </p><div class="fragment"><div class="line">curl -X POST -u user:pass -d <span class="stringliteral">'{"title":"A new bug","body":"Some error occurs"}'</span> \</div>
|
|
<div class="line"> https:<span class="comment">//api.github.com/repos/owner/repo/issues</span></div>
|
|
</div><!-- fragment --><p>The module also may send request using given token. In this case request is: </p><div class="fragment"><div class="line">curl -X POST -H <span class="stringliteral">"Authorization: token token"</span> -d <span class="stringliteral">'{"title":"A new bug","body":"Some error occurs"}'</span> \</div>
|
|
<div class="line"> https:<span class="comment">//api.github.com/repos/owner/repo/issues</span></div>
|
|
</div><!-- fragment --><p>This module depends on QtNetwork module. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="adc2325a4e86e2379e8ef4353ff00f3bb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GithubModule::GithubModule </td>
|
|
<td>(</td>
|
|
<td class="paramtype">QWidget * </td>
|
|
<td class="paramname"><em>parent</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>debugCmd</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">QMap< QString, QString > </td>
|
|
<td class="paramname"><em>params</em> = <code>QMap< QString, QString >()</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="class_github_module.html" title="The GithubModule class creates issue over GitHub. ">GithubModule</a> class constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parent</td><td>parent object </td></tr>
|
|
<tr><td class="paramname">debugCmd</td><td>show debug messages </td></tr>
|
|
<tr><td class="paramname">params</td><td>dynamic parametrs. Needed keys are the same as in <a class="el" href="config_8h.html">config.h</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa4216f8b9eb88ce568707df157b1b5fd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GithubModule::~GithubModule </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="class_github_module.html" title="The GithubModule class creates issue over GitHub. ">GithubModule</a> class destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a370fdede5483d2ad4c229a646e70dd93"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void GithubModule::sendReportUsingGithub </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QMap< QString, QString > </td>
|
|
<td class="paramname"><em>info</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>method which creates an issue </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">info</td><td>issue details. Needed keys are: body (body of an issue), password (GitHub password), title (title of an issue), userdata (given GitHub token, it is optional key), username (GitHub user name), </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="githubmodule_8h_source.html">githubmodule.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Fri Aug 1 2014 09:12:26 for reportabug by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.7
|
|
</small></address>
|
|
</body>
|
|
</html>
|