TODO list - some generic things that could/should be looked at

mdmngr.c

@@ -14,6 +14,42 @@
 
 #include "mdmngr.h"
 
+/**
+ * A TODO list with items on my mind. All points are not necessarily important,
+ * or even necessary, but just things I had intended to look at/investigate.
+ *
+ * TODO:
+ * 		1.	A method to get network status.
+ *		2.	Revisit ubus method names, are they consistent and clear?
+ *		3.	Change object name from dongle to mdmngr
+ *		4.	Revisit ubus prints (i.e. should the list in <ubus call dongle list>
+			be called "network_devices"?)
+ *		5.	Provide a debug level to the libraries from the flags parsed in mdmngr.c
+ *		6.	Document some of the hilink related functionality and library.
+ *		7.	Revisit some error-prints (should they be readable for humans or is
+			the purpose for them to be easily parsable? i.e. {"Success": "Profile changed"}
+			could be {"result": "success"}/{"result": "failure"})
+ *		8.	Revisit some error handling, can it be improved/condensed by using less
+			API calls, i.e. for the ZTE stick sim_state can be used to determine
+			whether the SIM is locked, is the same true for the hilink library?
+			If so the current sim_locked error check can be removed and added to sim_state.
+
+			Some calls are slow by default (i.e. pin related functionality on the ZTE dongle),
+			does the current error handling slow it down too much, making it feel unresponsive?
+ *		9.	Check with someone from kernel team if there's a problem with network
+			dongles on ex400, I spoke with Fredrik from the test team but he was
+			not able to get the dongle to show up on ex400 as well.
+		10.	Experiment with a USB to ethernet adapter, will our detection system
+			incorrectly identify the adapter as a LTE dongle?
+		11.	Should doxygen be added to ./iop setup_host? (Alex mentioned something
+			about this at some point).
+		12.	Fix compilation warnings.
+		13. I discovered no memory leaks last I tested, but probably should perform
+			some further tests.
+		14. When deleting profile, give error message if it is the current APN profile.
+		15.	Replace text strings in c files with defines.
+ */
+
 static int get_devices_from_path(char *input_path);
 static int get_devices(void);
 static int poll_devices(void);