theonepath
1964ac3290
Added all files related to doxygen doc file generation for the consideration of using doxygen as the base tool for doc generation of project.
184 lines
8.2 KiB
HTML
184 lines
8.2 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>CLog: clog.utils.common Namespace 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/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">CLog<span id="projectnumber"> 0.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">logging as simple as putting on a shoe</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceclog.html">clog</a></li><li class="navelem"><a class="el" href="namespaceclog_1_1utils.html">utils</a></li><li class="navelem"><a class="el" href="namespaceclog_1_1utils_1_1common.html">common</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">clog.utils.common Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classclog_1_1utils_1_1common_1_1_log_level.html">LogLevel</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ad740e3e24e0b55313afc77f1266c17f7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1common.html#ad740e3e24e0b55313afc77f1266c17f7">is_path_spec</a> (<a class="el" href="namespaceclog_1_1utils_1_1common.html#ae0a33f3fa086bf8d1fc18eb6b77c8352">str</a> path_spec)</td></tr>
|
|
<tr class="separator:ad740e3e24e0b55313afc77f1266c17f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:ae0a33f3fa086bf8d1fc18eb6b77c8352"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1common.html#ae0a33f3fa086bf8d1fc18eb6b77c8352">str</a></td></tr>
|
|
<tr class="memdesc:ae0a33f3fa086bf8d1fc18eb6b77c8352"><td class="mdescLeft"> </td><td class="mdescRight">get the name of the OS <a href="namespaceclog_1_1utils_1_1common.html#ae0a33f3fa086bf8d1fc18eb6b77c8352">More...</a><br /></td></tr>
|
|
<tr class="separator:ae0a33f3fa086bf8d1fc18eb6b77c8352"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafe1e24a709d3f182018cd90a77bba43"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1common.html#aafe1e24a709d3f182018cd90a77bba43">__REGEX_PAT</a> = re.compile(r'^(.+)[\\]([^\\]+)\\*$') \</td></tr>
|
|
<tr class="separator:aafe1e24a709d3f182018cd90a77bba43"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ad740e3e24e0b55313afc77f1266c17f7" name="ad740e3e24e0b55313afc77f1266c17f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad740e3e24e0b55313afc77f1266c17f7">◆ </a></span>is_path_spec()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"> bool clog.utils.common.is_path_spec </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceclog_1_1utils_1_1common.html#ae0a33f3fa086bf8d1fc18eb6b77c8352">str</a> </td>
|
|
<td class="paramname"><em>path_spec</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment">Evaluate if a given string is a valid pathspec identifier.
|
|
Pathspec evaluation is matched against the following regular
|
|
expression patterns:
|
|
```plaintext
|
|
OS Pathspec
|
|
NT: ^(.+)[\\\\]([^\\\\]+)\\*$
|
|
Other: ^(.+)[\\/]([^\\/]+)$
|
|
OR
|
|
Valid names of CWD subdirectories
|
|
^[\\w\\d\\-_]+$
|
|
```
|
|
The following pathspecs are evaluated as valid pathspec identifiers
|
|
(OS implicitly implied):
|
|
- C:\\User\\user-1\\Documents\\my-project
|
|
- $HOME/.local/bin/my_project
|
|
- ".\\Python Examples\\my-project1"
|
|
|
|
The following pathspecs are evaluated as invalid pathspec identifiers
|
|
(OS implicitly implied)
|
|
- ./this,_is-a(bad)+pathspec
|
|
|
|
`@Params`: path_spec - `str`
|
|
`@Return`: `bool`
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="aafe1e24a709d3f182018cd90a77bba43" name="aafe1e24a709d3f182018cd90a77bba43"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aafe1e24a709d3f182018cd90a77bba43">◆ </a></span>__REGEX_PAT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">clog.utils.common.__REGEX_PAT = re.compile(r'^(.+)[\\]([^\\]+)\\*$') \</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae0a33f3fa086bf8d1fc18eb6b77c8352" name="ae0a33f3fa086bf8d1fc18eb6b77c8352"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0a33f3fa086bf8d1fc18eb6b77c8352">◆ </a></span>str</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">clog.utils.common.str</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the name of the OS </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|