added licensing

1 files changed, 21 insertions, 3 deletions

diff --git a/include/task.h b/include/task.h
index 6456bdc..555a470 100644
--- a/include/task.h
+++ b/include/task.h
@@ -1,6 +1,21 @@
 /**
  * @file task.h
  * Provides multitasking functionality
+ *
+ * Copyright (C) 2018 Clyne Sullivan
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
 #ifndef TASK_H_
@@ -8,10 +23,13 @@
 
 #include <stdint.h>
 
+/**
+ * A structure to contain task data.
+ */
 typedef struct {
-	void *next;
-	uint32_t *stack;
-	uint32_t *sp;
+	void *next;      /**< pointer to the next task_t instance */
+	uint32_t *stack; /**< pointer to the task's stack */
+	uint32_t *sp;    /**< pointer to the task's last sp register value */
 } task_t;
 
 /**