fix some distributed documentation

ginkgo-project · Mar 29, 2022 · b1ee7d2 · b1ee7d2
1 parent fabd596
commit b1ee7d2
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/include/ginkgo/core/base/mpi.hpp b/include/ginkgo/core/base/mpi.hpp
@@ -55,6 +55,12 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 namespace gko {
+/**
+ * @brief The mpi namespace, contains wrapper for many MPI functions.
+ *
+ * @ingroup mpi
+ * @ingroup distributed
+ */
 namespace mpi {
 
 

diff --git a/include/ginkgo/core/distributed/partition.hpp b/include/ginkgo/core/distributed/partition.hpp
@@ -40,6 +40,11 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 namespace gko {
+/**
+ * @brief The distributed namespace.
+ *
+ * @ingroup distributed
+ */
 namespace distributed {
 
 
@@ -87,6 +92,7 @@ namespace distributed {
  * for(int i = 0; i < r[3] - r[2]; ++i){
  *   data[starting_index[2] + i] = val;
  * }
+ * ```
  *
  * @tparam LocalIndexType  The index type used for part-local indices.
  *                         To prevent overflows, no single part's size may

diff --git a/include/ginkgo/core/distributed/vector.hpp b/include/ginkgo/core/distributed/vector.hpp
@@ -78,6 +78,8 @@ class Partition;
  *
  * @ingroup dist_vector
  * @ingroup distributed
+ * @ingroup mat_formats
+ * @ingroup LinOp
  */
 template <typename ValueType = double>
 class Vector