Skip to content

Commit 1c20594

Browse files
committed
Add examples for seq_reader and seq_writer
1 parent 481dbc4 commit 1c20594

File tree

75 files changed

+4103
-1504
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+4103
-1504
lines changed

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -951,7 +951,7 @@ EXCLUDE_SYMBOLS = btllib::SeqReader::read_*
951951
# that contain example code fragments that are included (see the \include
952952
# command).
953953

954-
EXAMPLE_PATH =
954+
EXAMPLE_PATH = examples/
955955

956956
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
957957
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -965,7 +965,7 @@ EXAMPLE_PATTERNS = *
965965
# irrespective of the value of the RECURSIVE tag.
966966
# The default value is: NO.
967967

968-
EXAMPLE_RECURSIVE = NO
968+
EXAMPLE_RECURSIVE = YES
969969

970970
# The IMAGE_PATH tag can be used to specify one or more files or directories
971971
# that contain images that are to be included in the documentation (see the

docs/classbtllib_1_1SeqReader.html

Lines changed: 4 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -79,30 +79,6 @@
7979
<table class="memberdecls">
8080
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
8181
Classes</h2></td></tr>
82-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_fasta_buffer</b></td></tr>
83-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
84-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_fasta_file</b></td></tr>
85-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
86-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_fasta_transition</b></td></tr>
87-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
88-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_fastq_buffer</b></td></tr>
89-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
90-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_fastq_file</b></td></tr>
91-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
92-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_fastq_transition</b></td></tr>
93-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
94-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_gfa2_buffer</b></td></tr>
95-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
96-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_gfa2_file</b></td></tr>
97-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
98-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_gfa2_transition</b></td></tr>
99-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
100-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_sam_buffer</b></td></tr>
101-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
102-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_sam_file</b></td></tr>
103-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
104-
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>read_sam_transition</b></td></tr>
105-
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
10682
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structbtllib_1_1SeqReader_1_1Record.html">Record</a></td></tr>
10783
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
10884
</table><table class="memberdecls">
@@ -148,6 +124,8 @@
148124
</table>
149125
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
150126
<div class="textblock"><p>Read a FASTA, FASTQ, SAM, or GFA2 file. Threadsafe. </p>
127+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="seq_reader_8cpp-example.html#_a0">seq_reader.cpp</a>.</dd>
128+
</dl>
151129
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
152130
<a id="a36e075566d2d4a217933f9a9d6fe7e7d"></a>
153131
<h2 class="memtitle"><span class="permalink"><a href="#a36e075566d2d4a217933f9a9d6fe7e7d">&#9670;&nbsp;</a></span>Flag</h2>
@@ -193,6 +171,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7e8acc7bfbd8624cf8d97459
193171
</table>
194172
</div><div class="memdoc">
195173
<p>Read operator. </p>
174+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="seq_reader_8cpp-example.html#a2">seq_reader.cpp</a>.</dd>
175+
</dl>
196176

197177
</div>
198178
</div>

docs/classbtllib_1_1SeqWriter.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@
9797
</table>
9898
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
9999
<div class="textblock"><p>Write FASTA or FASTQ sequences to a file. Threadsafe. </p>
100+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="seq_writer_8cpp-example.html#_a0">seq_writer.cpp</a>.</dd>
101+
</dl>
100102
</div><hr/>The documentation for this class was generated from the following file:<ul>
101103
<li>include/btllib/<a class="el" href="seq__writer_8hpp_source.html">seq_writer.hpp</a></li>
102104
</ul>

docs/examples.html

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.18"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>btllib: Examples</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="search/searchdata.js"></script>
14+
<script type="text/javascript" src="search/search.js"></script>
15+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
16+
</head>
17+
<body>
18+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19+
<div id="titlearea">
20+
<table cellspacing="0" cellpadding="0">
21+
<tbody>
22+
<tr style="height: 56px;">
23+
<td id="projectalign" style="padding-left: 0.5em;">
24+
<div id="projectname">btllib
25+
</div>
26+
</td>
27+
</tr>
28+
</tbody>
29+
</table>
30+
</div>
31+
<!-- end header part -->
32+
<!-- Generated by Doxygen 1.8.18 -->
33+
<script type="text/javascript">
34+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
36+
/* @license-end */
37+
</script>
38+
<script type="text/javascript" src="menudata.js"></script>
39+
<script type="text/javascript" src="menu.js"></script>
40+
<script type="text/javascript">
41+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
$(function() {
43+
initMenu('',true,false,'search.php','Search');
44+
$(document).ready(function() { init_search(); });
45+
});
46+
/* @license-end */</script>
47+
<div id="main-nav"></div>
48+
</div><!-- top -->
49+
<!-- window showing the filter options -->
50+
<div id="MSearchSelectWindow"
51+
onmouseover="return searchBox.OnSearchSelectShow()"
52+
onmouseout="return searchBox.OnSearchSelectHide()"
53+
onkeydown="return searchBox.OnSearchSelectKey(event)">
54+
</div>
55+
56+
<!-- iframe showing the search results (closed by default) -->
57+
<div id="MSearchResultsWindow">
58+
<iframe src="javascript:void(0)" frameborder="0"
59+
name="MSearchResults" id="MSearchResults">
60+
</iframe>
61+
</div>
62+
63+
<div class="header">
64+
<div class="headertitle">
65+
<div class="title">Examples</div> </div>
66+
</div><!--header-->
67+
<div class="contents">
68+
<div class="textblock">Here is a list of all examples:</div><ul>
69+
<li><a class="el" href="seq_reader_8cpp-example.html">seq_reader.cpp</a></li>
70+
71+
<li><a class="el" href="seq_writer_8cpp-example.html">seq_writer.cpp</a></li>
72+
73+
</ul>
74+
</div><!-- contents -->
75+
<!-- start footer part -->
76+
<hr class="footer"/><address class="footer"><small>
77+
Generated by &#160;<a href="http://www.doxygen.org/index.html">
78+
<img class="footer" src="doxygen.png" alt="doxygen"/>
79+
</a> 1.8.18
80+
</small></address>
81+
</body>
82+
</html>

docs/menudata.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,5 @@ var menudata={children:[
3434
{text:"Enumerations",url:"functions_enum.html"},
3535
{text:"Enumerator",url:"functions_eval.html"}]}]},
3636
{text:"Files",url:"files.html",children:[
37-
{text:"File List",url:"files.html"}]}]}
37+
{text:"File List",url:"files.html"}]},
38+
{text:"Examples",url:"examples.html"}]}

0 commit comments

Comments
 (0)