Merge pull request #10999 from AlfredClemedtson/clique-counting-docs

Clique counting documentation

Author: AlfredClemedtson

doc-test/src/test/java/org/neo4j/gds/doc/CliqueCountingDocTest.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.doc;
+
+import org.neo4j.gds.cliquecounting.CliqueCountingMutateProc;
+import org.neo4j.gds.cliquecounting.CliqueCountingStatsProc;
+import org.neo4j.gds.cliquecounting.CliqueCountingStreamProc;
+import org.neo4j.gds.cliquecounting.CliqueCountingWriteProc;
+import org.neo4j.gds.functions.AsNodeFunc;
+
+import java.util.List;
+
+class CliqueCountingDocTest extends SingleFileDocTestBase {
+
+    @Override
+    protected List<Class<?>> functions() {
+        return List.of(AsNodeFunc.class);
+    }
+
+    @Override
+    protected List<Class<?>> procedures() {
+        return List.of(
+            CliqueCountingStreamProc.class,
+            CliqueCountingWriteProc.class,
+            CliqueCountingMutateProc.class,
+            CliqueCountingStatsProc.class
+        );
+    }
+
+    @Override
+    protected String adocFile() {
+        return "pages/algorithms/clique-counting.adoc";
+    }
+
+}

doc-test/src/test/java/org/neo4j/gds/doc/syntax/CliqueCountingSyntaxTest.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.gds.doc.syntax;
+
+class CliqueCountingSyntaxTest extends SyntaxTestBase {
+
+    @Override
+    protected String adocFile() {
+        return "pages/algorithms/clique-counting.adoc";
+    }
+}

doc/modules/ROOT/content-nav.adoc

@@ -68,6 +68,7 @@
 *** xref:algorithms/harmonic-centrality.adoc[]
 *** xref:algorithms/hits.adoc[]
 ** xref:algorithms/community.adoc[]
+*** xref:algorithms/clique-counting.adoc[]
 *** xref:algorithms/conductance.adoc[]
 *** xref:algorithms/hdbscan.adoc[]
 *** xref:algorithms/k-core.adoc[]