From 24499694116ff25a190e95533da09d0efaccffae Mon Sep 17 00:00:00 2001
From: Anton Khirnov <anton@khirnov.net>
Date: Sat, 1 Nov 2014 14:15:40 +0100
Subject: Add more documentation.

---
 brill_data.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/brill_data.h b/brill_data.h
index 125970b..b8b63e8 100644
--- a/brill_data.h
+++ b/brill_data.h
@@ -121,8 +121,20 @@ typedef struct BDContext {
     ptrdiff_t stride;
 } BDContext;
 
+/**
+ * Allocate and initialize the solver.
+ */
 BDContext *bd_context_alloc(void);
 
+/**
+ * Free the solver and everything associated with it.
+ */
 void bd_context_free(BDContext **bd);
 
+/**
+ * Solve the equation for the conformal factor ψ and export the expansion coefficients in the
+ * context.
+ *
+ * @return >= 0 on success, a negative error code on failure
+ */
 int bd_solve(BDContext *bd);
-- 
cgit v1.2.3