Fix to doxyfile, docstrings.

libscran · Jul 15, 2024 · 9bed220 · 9bed220
1 parent ba05ae4
commit 9bed220
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -906,7 +906,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../include/scran \
+INPUT                  = ../include/scran_graph_cluster \
                          ../README.md
 
 # This tag can be used to specify the character encoding of the source files

diff --git a/include/scran_graph_cluster/build_snn_graph.hpp b/include/scran_graph_cluster/build_snn_graph.hpp
@@ -93,7 +93,16 @@ struct BuildSnnGraphResults {
 typedef igraph_integer_t DefaultNode;
 typedef igraph_real_t DefaultWeight;
 #else
+/**
+ * Default type for the node indices.
+ * Set to `igraph_integer_t` if **igraph** is available.
+ */
 typedef int DefaultNode;
+
+/**
+ * Default type for the edge weights.
+ * Set to `igraph_real_t` if **igraph** is available.
+ */
 typedef double DefaultWeight;
 #endif