From 93b629e504900432ea712cc3ed65dd937483e1c1 Mon Sep 17 00:00:00 2001
From: Laurence Kedward <laurence.kedward@bristol.ac.uk>
Date: Sat, 27 Nov 2021 17:35:12 +0000
Subject: Add: developer documentation to new files

---
 src/ptycheck/isatty.c | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'src/ptycheck/isatty.c')

diff --git a/src/ptycheck/isatty.c b/src/ptycheck/isatty.c
index 61acee6..9b7f519 100644
--- a/src/ptycheck/isatty.c
+++ b/src/ptycheck/isatty.c
@@ -1,10 +1,17 @@
+// This file provides a `c_isatty` wrapper function to check if `stdout` is connected
+// to a terminal or not. This wrapper is required for better portability, specifically
+// for supporting the MS Windows command prompt and the MinTTY terminal used by MSYS2.
+
 #include <unistd.h>	//for isatty()
 #include <stdio.h>	//for fileno()
 
 #ifdef __MINGW64__
+// ptycheck/iscygpty allows us to check if connected to MinTTY in MSYS2 on Windows
 #include "iscygpty.h"
 #endif
 
+// Check if `stdout` is connected to a terminal
+// Returns 1 if is a terminal, and 0 otherwise
 int c_isatty(void)
 {
 
-- 
cgit v1.2.3