Add documentation on the cookie version field

2016-09-13 23:38:22 +01:00 · 2016-09-13 23:38:22 +01:00 · b78e887ba0
parent bd4377d693
commit b78e887ba0
1 changed files with 8 additions and 0 deletions
--- a/include/netsurf/cookie_db.h
+++ b/include/netsurf/cookie_db.h
@ -27,6 +27,14 @@
 #include <stdbool.h>
 #include <time.h>

+/**
+ * Version of cookie
+ *
+ * RFC2109 and RFC2965 "HTTP State Management Mechanism" defined
+ * alternative versions of cookies. Nothing used them and these RFC
+ * are now obsoleted by RFC6265 which completely removes the
+ * alternative versions.
+ */
 enum cookie_version {
 	COOKIE_NETSCAPE = 0,
 	COOKIE_RFC2109 = 1,