about summary refs log tree commit diff stats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/config/preferences.c10
-rw-r--r--src/config/preferences.h2
2 files changed, 12 insertions, 0 deletions
diff --git a/src/config/preferences.c b/src/config/preferences.c
index aeff94f1..fe6d0626 100644
--- a/src/config/preferences.c
+++ b/src/config/preferences.c
@@ -52,6 +52,7 @@
 #include "preferences.h"
 #include "tools/autocomplete.h"
 
+// preference groups refer to the sections in .profrc, for example [ui]
 #define PREF_GROUP_LOGGING "logging"
 #define PREF_GROUP_CHATSTATES "chatstates"
 #define PREF_GROUP_UI "ui"
@@ -487,6 +488,9 @@ _get_preferences_file(void)
     return result;
 }
 
+// get the preference group for a specific preference
+// for example the PREF_BEEP setting ("beep" in .profrc, see _get_key) belongs
+// to the [ui] section.
 static const char *
 _get_group(preference_t pref)
 {
@@ -552,6 +556,8 @@ _get_group(preference_t pref)
     }
 }
 
+// get the key used in .profrc for the preference
+// for example the PREF_AUTOAWAY_MODE maps to "autoaway.mode" in .profrc
 static const char *
 _get_key(preference_t pref)
 {
@@ -658,6 +664,8 @@ _get_key(preference_t pref)
     }
 }
 
+// the default setting for a boolean type preference
+// if it is not specified in .profrc
 static gboolean
 _get_default_boolean(preference_t pref)
 {
@@ -681,6 +689,8 @@ _get_default_boolean(preference_t pref)
     }
 }
 
+// the default setting for a string type preference
+// if it is not specified in .profrc
 static char *
 _get_default_string(preference_t pref)
 {
diff --git a/src/config/preferences.h b/src/config/preferences.h
index 54b4cefe..0a953482 100644
--- a/src/config/preferences.h
+++ b/src/config/preferences.h
@@ -47,6 +47,8 @@
 #define PREFS_MIN_LOG_SIZE 64
 #define PREFS_MAX_LOG_SIZE 1048580
 
+// represents all settings in .profrc
+// each enum value is mapped to a group and key in .profrc (see preferences.c)
 typedef enum {
     PREF_SPLASH,
     PREF_BEEP,
dev> 2019-05-13 22:25:16 -0400 committer Ben Morrison <ben@gbmor.dev> 2019-05-13 22:34:22 -0400 commented indexHandler' href='/gbmor/getwtxt/commit/handlers.go?h=v0.2.4&id=df79157454391a17bb9276cf44d9141d1a29b8f6'>df79157 ^
dbc93a0 ^





a6f47c0 ^


07872ef ^



1168570 ^
d3d9df2 ^

1168570 ^
df1d1ef ^
747f4fb ^
1168570 ^


893123c ^
fc49c57 ^
df1d1ef ^
893123c ^
b9d16fb ^
1168570 ^

747f4fb ^
1168570 ^



b9d16fb ^
d3d9df2 ^
1168570 ^
4fa97ee ^
b6e7bb3 ^
1168570 ^
4fa97ee ^
b9d16fb ^
d3d9df2 ^
37be25f ^
505c5d8 ^
27f92d8 ^
37be25f ^
505c5d8 ^

1168570 ^
4fa97ee ^
d2680fb ^
1168570 ^
3596509 ^
1168570 ^
d2680fb ^

1168570 ^
4fa97ee ^
fc49c57 ^
1168570 ^
3596509 ^
1168570 ^
d6fbc25 ^
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82