From d1a4b90dc255f3e8bea032677a51af3e9379e348 Mon Sep 17 00:00:00 2001 From: Aareon Sullivan Date: Fri, 15 Mar 2019 10:51:33 -0700 Subject: [PATCH] Create documentation This is just a proof-of-concept. If you have a preferred way to style this, let me know. Also, let me know if anything is either factually incorrect, too summarized, or too verbose. First commit is `server_init` --- kiwmi/server.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/kiwmi/server.c b/kiwmi/server.c index 6c87021..7234e08 100644 --- a/kiwmi/server.c +++ b/kiwmi/server.c @@ -26,6 +26,16 @@ bool server_init(struct kiwmi_server *server) { + // Returns a boolean depending on the success or failure of creating + // the various components we need. + // + // Setup the display and display backend. If we can't create the backend + // we log it, destroy the display and return. Then create the + // renderer and initialize it, as well as the compositor, the device- + // manager, and the cursor. If we can't create the cursor, fail out. + // We then tell Wayland that `&server->outputs` is where we + // want to receive events, and that we will send Wayland our events + // via `&server->inputs`. If all of this goes well, return `true`. wlr_log(WLR_DEBUG, "Initializing Wayland server"); server->wl_display = wl_display_create();