-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
192 lines (111 loc) · 5.54 KB
/
index.html
File metadata and controls
192 lines (111 loc) · 5.54 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Fmt Parser library</title>
<link rel="stylesheet" href="_static/css/redactor.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/doxyrest-pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="fmtparser documentation" href="#"/>
<link rel="next" title="Simple API usage example" href="example.html"/>
</head>
<body role="document">
<a href="#" id="js-navigation-toggle" class="navigation-toggle">
<i class="mdi mdi-menu"></i><i class="mdi mdi-close"></i>
</a>
<section class="site-sidebar">
<nav>
<a href="#" class="branding-link">
<img src="_static/fmtparser.png" class="logo" />
</a>
<section role="search">
<form action="search.html" method="get" class="site-searchform">
<input type="text" name="q" placeholder="Search in documentation" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</section>
<section class="site-nav">
<p class="caption"><span class="caption-text">Core API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="example.html">Simple API usage example</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_fmt_parser.html">Parser API</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_fmt_util.html">Utility functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_fmt_spec.html">Format specifier</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_fmt_spec_api.html">Specifier API</a></li>
</ul>
<p class="caption"><span class="caption-text">Advanced topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="global.html">Global Namespace</a></li>
</ul>
</section>
</nav>
</section>
<main class="site-main" role="main">
<nav class="site-breadcrumbs">
<ul>
<li>
<a href="#">Documentation</a> /
</li>
<li class="site-breadcrumbs__leaf">Fmt Parser library</li>
</ul>
</nav>
<section class="site-content">
<div class="container">
<div class="section" id="fmt-parser-library">
<span id="index"></span><h1>Fmt Parser library<a class="headerlink" href="#fmt-parser-library" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<p>A light-weight implementation of printf-like format string.</p>
<p>The main idea of the project is to send tasks to the analyzer and get a set of reports back.</p>
<p class="rubric">Building</p>
<p>The project is based on CMake, so use a typical CMake approach:</p>
<pre class="highlight literal-block"><span></span>mkdir -p build <span class="o">&&</span> <span class="nb">cd</span> build
cmake -GNinja ..</pre>
<p>There is a simple <code class="docutils literal notranslate"><span class="pre">tools/make.sh</span></code> wrapper:</p>
<pre class="highlight literal-block"><span></span>./tools/make.sh</pre>
<p>To build for Windows on Linux, you may need MinGW. Then use:</p>
<pre class="highlight literal-block"><span></span>./tools/make.sh --win32</pre>
<p>To build with unit tests, add <code class="docutils literal notranslate"><span class="pre">--test</span></code> key.</p>
<p class="rubric">Documentation</p>
<p>It is possible to generate Doxygen/Sphinx documentation using the following shell command on UNIX-based operating systems:</p>
<pre class="highlight literal-block"><span></span>./tools/generate_doc.sh</pre>
<p>The documentation will be located in <code class="docutils literal notranslate"><span class="pre">build/html</span></code> folder.</p>
</div>
</div>
</section>
<nav class="site-bottom-navigation" role="navigation">
<a href="example.html" class="btn btn--primary btn--next right"
title="Simple API usage example" accesskey="n">
Next
</a>
</nav>
<div class="source-link">
</div>
</main>
<footer class="site-footer">
<div class="container">
<div role="contentinfo">
<p>
© Copyright 2021, Maxim Menshikov.
</p>
</div>
<p>Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/testthedocs/sphinx_redactor_theme">theme</a>
provided by <a href="https://testthedocs.org">TestTheDocs</a>.
</div>
</footer>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="_static/target-highlight.js"></script>
<script type="text/javascript" src="_static/js/theme-min.js"></script>
</body>
</html>