[doc] Added header comments for lib modules

- common.c/.h - sg.c/.h - usb.c/.h
stlink-org · Jun 7, 2023 · dbe13de · dbe13de
1 parent c8eaebc
commit dbe13de
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 3 deletions.
diff --git a/src/stlink-lib/common.c b/src/stlink-lib/common.c
@@ -1,3 +1,12 @@
+/* == nightwalker-87: TODO: CONTENT AND USE OF THIS SOURCE FILE IS TO BE VERIFIED (07.06.2023) == */
+/* TODO: This file should be split up into new or existing modules. */
+
+/*
+ * File: common.c
+ *
+ *
+ */
+
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>

diff --git a/src/stlink-lib/common.h b/src/stlink-lib/common.h
@@ -1,7 +1,10 @@
+/* == nightwalker-87: TODO: CONTENT AND USE OF THIS SOURCE FILE IS TO BE VERIFIED (07.06.2023) == */
+/* TODO: This file should be split up into new or existing modules. */
+
 /*
  * File: common.h
  *
- * General helper functions
+ *
  */
 
 #ifndef COMMON_H

diff --git a/src/stlink-lib/sg.c b/src/stlink-lib/sg.c
@@ -1,3 +1,5 @@
+/* == nightwalker-87: TODO: CONTENT AND USE OF THIS SOURCE FILE IS TO BE VERIFIED (07.06.2023) == */
+
 /*
  * Copyright (c) 2010 "Capt'ns Missing Link" Authors. All rights reserved.
  * Use of this source code is governed by a BSD-style

diff --git a/src/stlink-lib/sg.h b/src/stlink-lib/sg.h
@@ -1,3 +1,5 @@
+/* == nightwalker-87: TODO: CONTENT AND USE OF THIS HEADER FILE IS TO BE VERIFIED (07.06.2023) == */
+
 /*
  * File: sg.h
  *

diff --git a/src/stlink-lib/usb.c b/src/stlink-lib/usb.c
@@ -1,7 +1,7 @@
 /*
  * File: usb.c
  *
- * 
+ * USB commands & interaction with ST-LINK devices
  */
 
 #include <limits.h>

diff --git a/src/stlink-lib/usb.h b/src/stlink-lib/usb.h
@@ -1,7 +1,7 @@
 /*
  * File: usb.h
  *
- * 
+ * USB commands & interaction with ST-LINK devices
  */
 
 #ifndef USB_H