From f910579e66a1495c4c1c97e2b99ea178d9d194ee Mon Sep 17 00:00:00 2001
From: pacien
Date: Sat, 9 Dec 2017 01:59:50 +0100
Subject: Add proper struct documentation

Signed-off-by: pacien <pacien.trangirard@pacien.net>
---
 include/common/matrix.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'include/common/matrix.h')

diff --git a/include/common/matrix.h b/include/common/matrix.h
index 726a8ab..fe4a12a 100644
--- a/include/common/matrix.h
+++ b/include/common/matrix.h
@@ -12,8 +12,12 @@
 #include "geom.h"
 
 /**
- * Type: IntSquareMatrix
+ * Struct: IntSquareMatrix
  * Represents a square integer matrix.
+ *
+ * Fields:
+ *   **elements - NULL-terminated array of element pointers
+ *   dim        - dimension
  */
 typedef struct {
   IntVector **elements;
-- 
cgit v1.2.3