Skip to content

Add Doxygen Documentation docs pages. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evanhyd merged 5 commits into from
Jul 21, 2025
Merged

Add Doxygen Documentation docs pages. #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c863d1a
Add doxygen documentation.
evanhyd Jul 21, 2025
447311a
Update documentation
evanhyd Jul 21, 2025
ea48a94
Update documentation
evanhyd Jul 21, 2025
037012d
Add oxygen documentation.
evanhyd Jul 21, 2025
0e966b7
Fix documentation.
evanhyd Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# --------- Project Info ---------
PROJECT_NAME = "Flow"
PROJECT_BRIEF = "Documentation for the Flow C++ Library"
OUTPUT_DIRECTORY = docs
CREATE_SUBDIRS = NO

# --------- Build Control ---------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_ANON_NSPACES = YES

# --------- Input Settings ---------
INPUT = DataStructure/
RECURSIVE = YES
FILE_PATTERNS = flow_*.cpp flow_*.h flow_*.hpp flow_*.cxx flow_*.cc
EXCLUDE =

# --------- Source Browsing ---------
SOURCE_BROWSER = YES
INLINE_SOURCES = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES

# --------- Output Formats ---------
GENERATE_HTML = YES
HTML_OUTPUT = .
HTML_FILE_EXTENSION = .html
HTML_COLORSTYLE_HUE = 220
HTML_DYNAMIC_SECTIONS = YES
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
GENERATE_XML = NO
GENERATE_DOCBOOK = NO

# --------- Markdown Support ---------
MARKDOWN_SUPPORT =
USE_MDFILE_AS_MAINPAGE =

# --------- Warnings ---------
WARN_IF_UNDOCUMENTED = YES
WARN_NO_PARAMDOC = YES

# --------- Misc ---------
QUIET = NO
WARNINGS = YES
GENERATE_TREEVIEW = YES
STRIP_FROM_PATH = DataStructure/
131 changes: 131 additions & 0 deletions docs/annotated.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<!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" lang="en-US">
<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.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: Class List</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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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">Flow
</div>
<div id="projectbrief">Documentation for the Flow C++ Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('annotated.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="headertitle"><div class="title">Class List</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:dynsection.toggleLevel(1);">1</span><span onclick="javascript:dynsection.toggleLevel(2);">2</span><span onclick="javascript:dynsection.toggleLevel(3);">3</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="dynsection.toggleFolder('0_')"><span class="arrowhead opened"></span></span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceflow.html" target="_self">flow</a></td><td class="desc"></td></tr>
<tr id="row_0_0_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_arena_memory_resource.html" target="_self">ArenaMemoryResource</a></td><td class="desc">A linear arena memory resource that allocates memory sequentially from a fixed buffer. Throws std::bad_alloc if there is insufficient space for the requested allocation </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="dynsection.toggleFolder('0_1_')"><span class="arrowhead opened"></span></span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_concurrent_flex_queue.html" target="_self">ConcurrentFlexQueue</a></td><td class="desc"></td></tr>
<tr id="row_0_1_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structflow_1_1_concurrent_flex_queue_1_1_node.html" target="_self">Node</a></td><td class="desc"></td></tr>
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_concurrent_queue.html" target="_self">ConcurrentQueue</a></td><td class="desc"></td></tr>
<tr id="row_0_3_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_counted_value_view_iterator.html" target="_self">CountedValueViewIterator</a></td><td class="desc">Iterator that returns a constant value for a fixed number of times. Useful for creating a virtual range of repeated values without storage </td></tr>
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_debug_class.html" target="_self">DebugClass</a></td><td class="desc">Debug class that tracks object's copy/move opeartions. Note that some of the operations may get optimized away with optimization on </td></tr>
<tr id="row_0_5_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_default_memory_resource.html" target="_self">DefaultMemoryResource</a></td><td class="desc">A default memory resource that wraps global ::operator new and ::operator delete </td></tr>
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_memory_resource.html" target="_self">MemoryResource</a></td><td class="desc">A memory resource holder interface for the <a class="el" href="classflow_1_1_polymorphic_allocator.html" title="A polymorphic allocator that wraps around a non-owning memory resource. Memory allocation strategy is...">PolymorphicAllocator</a>. Responsible for allocate and deallocate raw memory </td></tr>
<tr id="row_0_7_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_polymorphic_allocator.html" target="_self">PolymorphicAllocator</a></td><td class="desc">A polymorphic allocator that wraps around a non-owning memory resource. Memory allocation strategy is decided by memory resource's implementation </td></tr>
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_8_" class="arrow" onclick="dynsection.toggleFolder('0_8_')"><span class="arrowhead opened"></span></span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_pool_memory_resource.html" target="_self">PoolMemoryResource</a></td><td class="desc">A pool memory resource that manages fixed-size memory blocks from a pre-allocated buffer. The allocation size must be less or equal to the block size. The allocation alignment must be less or equal to the block alignment. Throws std::bad_alloc if the constraint is not met or run out of memory </td></tr>
<tr id="row_0_8_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structflow_1_1_pool_memory_resource_1_1_header.html" target="_self">Header</a></td><td class="desc"></td></tr>
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_9_" class="arrow" onclick="dynsection.toggleFolder('0_9_')"><span class="arrowhead opened"></span></span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_stack_memory_resource.html" target="_self">StackMemoryResource</a></td><td class="desc">A stack-based memory resource that allocates memory in a LIFO order from a fixed buffer. Deallocation must happen in reverse order of allocation. Throws std::bad_alloc if there is insufficient space for an allocation </td></tr>
<tr id="row_0_9_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structflow_1_1_stack_memory_resource_1_1_header.html" target="_self">Header</a></td><td class="desc"></td></tr>
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_timer.html" target="_self">Timer</a></td><td class="desc">A simple timer to record timelapses. Uses chrono::steady_clock by default </td></tr>
<tr id="row_0_11_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_tuple.html" target="_self">Tuple</a></td><td class="desc"></td></tr>
<tr id="row_0_12_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_tuple_3_01_t_00_01_ts_8_8_8_01_4.html" target="_self">Tuple&lt; T, Ts... &gt;</a></td><td class="desc"></td></tr>
<tr id="row_0_13_" class="odd"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classflow_1_1_vector.html" target="_self">Vector</a></td><td class="desc"></td></tr>
<tr id="row_0_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_14_" class="arrow" onclick="dynsection.toggleFolder('0_14_')"><span class="arrowhead opened"></span></span><span class="icona"><span class="icon">C</span></span><a class="el" href="structflow_1_1_vector_growth_strategy.html" target="_self">VectorGrowthStrategy</a></td><td class="desc"></td></tr>
<tr id="row_0_14_0_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structflow_1_1_vector_growth_strategy_1_1_double_expand.html" target="_self">DoubleExpand</a></td><td class="desc"></td></tr>
<tr id="row_0_14_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structflow_1_1_vector_growth_strategy_1_1_fibonacci_expand.html" target="_self">FibonacciExpand</a></td><td class="desc"></td></tr>
<tr id="row_0_14_2_" class="odd"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structflow_1_1_vector_growth_strategy_1_1_golden_expand.html" target="_self">GoldenExpand</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>
20 changes: 20 additions & 0 deletions docs/annotated_dup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
var annotated_dup =
[
[ "flow", "namespaceflow.html", [
[ "ArenaMemoryResource", "classflow_1_1_arena_memory_resource.html", "classflow_1_1_arena_memory_resource" ],
[ "ConcurrentFlexQueue", "classflow_1_1_concurrent_flex_queue.html", "classflow_1_1_concurrent_flex_queue" ],
[ "ConcurrentQueue", "classflow_1_1_concurrent_queue.html", "classflow_1_1_concurrent_queue" ],
[ "CountedValueViewIterator", "classflow_1_1_counted_value_view_iterator.html", "classflow_1_1_counted_value_view_iterator" ],
[ "DebugClass", "classflow_1_1_debug_class.html", "classflow_1_1_debug_class" ],
[ "DefaultMemoryResource", "classflow_1_1_default_memory_resource.html", "classflow_1_1_default_memory_resource" ],
[ "MemoryResource", "classflow_1_1_memory_resource.html", "classflow_1_1_memory_resource" ],
[ "PolymorphicAllocator", "classflow_1_1_polymorphic_allocator.html", "classflow_1_1_polymorphic_allocator" ],
[ "PoolMemoryResource", "classflow_1_1_pool_memory_resource.html", "classflow_1_1_pool_memory_resource" ],
[ "StackMemoryResource", "classflow_1_1_stack_memory_resource.html", "classflow_1_1_stack_memory_resource" ],
[ "Timer", "classflow_1_1_timer.html", "classflow_1_1_timer" ],
[ "Tuple", "classflow_1_1_tuple.html", "classflow_1_1_tuple" ],
[ "Tuple< T, Ts... >", "classflow_1_1_tuple_3_01_t_00_01_ts_8_8_8_01_4.html", "classflow_1_1_tuple_3_01_t_00_01_ts_8_8_8_01_4" ],
[ "Vector", "classflow_1_1_vector.html", "classflow_1_1_vector" ],
[ "VectorGrowthStrategy", "structflow_1_1_vector_growth_strategy.html", "structflow_1_1_vector_growth_strategy" ]
] ]
];
Loading