Skip to content

Commit

Permalink
new doxygen main page
Browse files Browse the repository at this point in the history
  • Loading branch information
@oxy86
oxy86 committed Dec 9, 2024
1 parent 61dfca6 commit 363fd4b
Show file tree
Hide file tree
Showing 186 changed files with 985 additions and 953 deletions.
22 changes: 11 additions & 11 deletions astro.config.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export default defineConfig({
site: 'https://socnetv.org',
base: '/',
redirects: {
'/docs/formats.html': '/docs/formats'
'/docs/formats.html': '/manual/formats'
},
integrations: [
starlight({
Expand Down Expand Up @@ -48,16 +48,16 @@ export default defineConfig({
{
label: 'Manual',
items: [
{ label: 'Introduction', slug: 'docs/intro' },
{ label: 'User Interface', slug: 'docs/gui' },
{ label: 'Formats', slug: 'docs/formats' },
{ label: 'Generate', slug: 'docs/generate' },
{ label: 'Analysis', slug: 'docs/analysis' },
{ label: 'Visualization', slug: 'docs/visualization' },
{ label: 'Credits', slug: 'docs/credits' },
{ label: 'References', slug: 'docs/references' },
{ label: 'License', slug: 'docs/license' },
{ label: 'Bugs', slug: 'docs/bugs' },
{ label: 'Introduction', slug: 'manual/intro' },
{ label: 'User Interface', slug: 'manual/gui' },
{ label: 'Formats', slug: 'manual/formats' },
{ label: 'Generate', slug: 'manual/generate' },
{ label: 'Analysis', slug: 'manual/analysis' },
{ label: 'Visualization', slug: 'manual/visualization' },
{ label: 'Credits', slug: 'manual/credits' },
{ label: 'References', slug: 'manual/references' },
{ label: 'License', slug: 'manual/license' },
{ label: 'Bugs', slug: 'manual/bugs' },
],
},
{ label: 'Downloads', slug: 'downloads' },
Expand Down
4 changes: 2 additions & 2 deletions public/annotation-src/header.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<!--BEGIN PROJECT_NAME--><title>$projectname code annotation: $title</title><!--END PROJECT_NAME-->
<!--BEGIN PROJECT_NAME--><title>$title | SocNetV Code Documentation </title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<meta name="keywords" content="manual,social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<meta name="keywords" content="source code annotation,code documentation, social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<meta name="trademark" content="SocNetV" />
<meta name="AUTHOR" content="Dimitris Kalamaras" />
<meta name="ROBOTS" content="INDEX, FOLLOW" />
Expand Down
14 changes: 11 additions & 3 deletions public/annotation-src/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# Welcome

These pages host the annotated code of our project, SocNetV.
Welcome to the **Social Network Visualizer** code documentation. This documentation provides detailed annotations of the **SocNetV** source code, generated using **Doxygen**. It serves as a reference for developers working with or contributing to the project.

Select what you want to see from the sidebar.
## What You'll Find Here

- **Source code documentation**: In-depth descriptions of classes, functions, methods, and variables, including their parameters, return values, and usage.
- **API reference**: A comprehensive listing of the project's public API, enabling developers to understand how to interact with the core functionality.
- **Class and function diagrams**: Visual representations of class hierarchies and function relationships within the code.
- **Code navigation**: Links to relevant code files, helping you easily locate specific parts of the project.

This documentation is generated directly from the **source code annotations** and reflects the current state of the codebase.

For the **user manual** and more details on how to use SocNetV, please visit the official manual at [socnetv.org](https://socnetv.org).

Visit our website at: [Social Network Visualizer](https://socnetv.org)
10 changes: 5 additions & 5 deletions public/docs/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Social Network Visualizer code annotation: Data Structures</title>
<meta name="keywords" content="manual,social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<title>Data Structures | SocNetV Code Documentation </title>
<meta name="keywords" content="source code annotation,code documentation, social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<meta name="trademark" content="SocNetV" />
<meta name="AUTHOR" content="Dimitris Kalamaras" />
<meta name="ROBOTS" content="INDEX, FOLLOW" />
Expand Down Expand Up @@ -46,9 +46,9 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="socnetv-logo-manual.png"/></td>
<td id="projectalign">
<div id="projectname">Social Network Visualizer<span id="projectnumber">&#160;3.1</span>
<div id="projectname">Code Documentation<span id="projectnumber">&#160;3.1</span>
</div>
<div id="projectbrief">Source code annotation</div>
<div id="projectbrief">Social Network Visualizer</div>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -150,7 +150,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Social Network Visualizer</strong></a> - All Rights Reserved -
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Code Documentation</strong></a> - All Rights Reserved -
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.8 </li>
</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions public/docs/bug.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Social Network Visualizer code annotation: Bug List</title>
<meta name="keywords" content="manual,social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<title>Bug List | SocNetV Code Documentation </title>
<meta name="keywords" content="source code annotation,code documentation, social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<meta name="trademark" content="SocNetV" />
<meta name="AUTHOR" content="Dimitris Kalamaras" />
<meta name="ROBOTS" content="INDEX, FOLLOW" />
Expand Down Expand Up @@ -46,9 +46,9 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="socnetv-logo-manual.png"/></td>
<td id="projectalign">
<div id="projectname">Social Network Visualizer<span id="projectnumber">&#160;3.1</span>
<div id="projectname">Code Documentation<span id="projectnumber">&#160;3.1</span>
</div>
<div id="projectbrief">Source code annotation</div>
<div id="projectbrief">Social Network Visualizer</div>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -129,7 +129,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Social Network Visualizer</strong></a> - All Rights Reserved -
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Code Documentation</strong></a> - All Rights Reserved -
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.8 </li>
</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions public/docs/chart_8cpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Social Network Visualizer code annotation: /home/dimitris/socnetv/app/src/chart.cpp File Reference</title>
<meta name="keywords" content="manual,social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<title>/home/dimitris/socnetv/app/src/chart.cpp File Reference | SocNetV Code Documentation </title>
<meta name="keywords" content="source code annotation,code documentation, social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<meta name="trademark" content="SocNetV" />
<meta name="AUTHOR" content="Dimitris Kalamaras" />
<meta name="ROBOTS" content="INDEX, FOLLOW" />
Expand Down Expand Up @@ -46,9 +46,9 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="socnetv-logo-manual.png"/></td>
<td id="projectalign">
<div id="projectname">Social Network Visualizer<span id="projectnumber">&#160;3.1</span>
<div id="projectname">Code Documentation<span id="projectnumber">&#160;3.1</span>
</div>
<div id="projectbrief">Source code annotation</div>
<div id="projectbrief">Social Network Visualizer</div>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -187,7 +187,7 @@
<ul>
<li class="navelem"><a class="el" href="dir_d422163b96683743ed3963d4aac17747.html">app</a></li><li class="navelem"><a class="el" href="dir_a8f641299cfea9f7461c2df1141b7786.html">src</a></li><li class="navelem"><a class="el" href="chart_8cpp.html">chart.cpp</a></li>
<li class="footer">
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Social Network Visualizer</strong></a> - All Rights Reserved -
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Code Documentation</strong></a> - All Rights Reserved -
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.8 </li>
</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions public/docs/chart_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Social Network Visualizer code annotation: /home/dimitris/socnetv/app/src/chart.h File Reference</title>
<meta name="keywords" content="manual,social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<title>/home/dimitris/socnetv/app/src/chart.h File Reference | SocNetV Code Documentation </title>
<meta name="keywords" content="source code annotation,code documentation, social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<meta name="trademark" content="SocNetV" />
<meta name="AUTHOR" content="Dimitris Kalamaras" />
<meta name="ROBOTS" content="INDEX, FOLLOW" />
Expand Down Expand Up @@ -46,9 +46,9 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="socnetv-logo-manual.png"/></td>
<td id="projectalign">
<div id="projectname">Social Network Visualizer<span id="projectnumber">&#160;3.1</span>
<div id="projectname">Code Documentation<span id="projectnumber">&#160;3.1</span>
</div>
<div id="projectbrief">Source code annotation</div>
<div id="projectbrief">Social Network Visualizer</div>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -161,7 +161,7 @@
<ul>
<li class="navelem"><a class="el" href="dir_d422163b96683743ed3963d4aac17747.html">app</a></li><li class="navelem"><a class="el" href="dir_a8f641299cfea9f7461c2df1141b7786.html">src</a></li><li class="navelem"><a class="el" href="chart_8h.html">chart.h</a></li>
<li class="footer">
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Social Network Visualizer</strong></a> - All Rights Reserved -
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Code Documentation</strong></a> - All Rights Reserved -
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.8 </li>
</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions public/docs/chart_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Social Network Visualizer code annotation: /home/dimitris/socnetv/app/src/chart.h Source File</title>
<meta name="keywords" content="manual,social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<title>/home/dimitris/socnetv/app/src/chart.h Source File | SocNetV Code Documentation </title>
<meta name="keywords" content="source code annotation,code documentation, social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<meta name="trademark" content="SocNetV" />
<meta name="AUTHOR" content="Dimitris Kalamaras" />
<meta name="ROBOTS" content="INDEX, FOLLOW" />
Expand Down Expand Up @@ -46,9 +46,9 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="socnetv-logo-manual.png"/></td>
<td id="projectalign">
<div id="projectname">Social Network Visualizer<span id="projectnumber">&#160;3.1</span>
<div id="projectname">Code Documentation<span id="projectnumber">&#160;3.1</span>
</div>
<div id="projectbrief">Source code annotation</div>
<div id="projectbrief">Social Network Visualizer</div>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -259,7 +259,7 @@
<ul>
<li class="navelem"><a class="el" href="dir_d422163b96683743ed3963d4aac17747.html">app</a></li><li class="navelem"><a class="el" href="dir_a8f641299cfea9f7461c2df1141b7786.html">src</a></li><li class="navelem"><a class="el" href="chart_8h.html">chart.h</a></li>
<li class="footer">
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Social Network Visualizer</strong></a> - All Rights Reserved -
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Code Documentation</strong></a> - All Rights Reserved -
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.8 </li>
</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions public/docs/classChart.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Social Network Visualizer code annotation: Chart Class Reference</title>
<meta name="keywords" content="manual,social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<title>Chart Class Reference | SocNetV Code Documentation </title>
<meta name="keywords" content="source code annotation,code documentation, social network analysis software, Social Network Visualizer, social network analysis, SocNetV, graphs, social network visualization, network layout, social network analysis tool, social network analysis datasets, centrality, graph theory" />
<meta name="trademark" content="SocNetV" />
<meta name="AUTHOR" content="Dimitris Kalamaras" />
<meta name="ROBOTS" content="INDEX, FOLLOW" />
Expand Down Expand Up @@ -46,9 +46,9 @@
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="socnetv-logo-manual.png"/></td>
<td id="projectalign">
<div id="projectname">Social Network Visualizer<span id="projectnumber">&#160;3.1</span>
<div id="projectname">Code Documentation<span id="projectnumber">&#160;3.1</span>
</div>
<div id="projectbrief">Source code annotation</div>
<div id="projectbrief">Social Network Visualizer</div>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -1126,7 +1126,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6dcaf24ec43e6521ba3046a9
<ul>
<li class="navelem"><a class="el" href="classChart.html">Chart</a></li>
<li class="footer">
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Social Network Visualizer</strong></a> - All Rights Reserved -
&copy; 2024 <a href="https://socnetv.org" target="_blank" style="color: white; text-decoration: none;"><strong>Code Documentation</strong></a> - All Rights Reserved -
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.8 </li>
</ul>
</div>
Expand Down
Loading

0 comments on commit 363fd4b

Please sign in to comment.