Skip to content

Commit e10386d

Browse files
committed
add comment docs
1 parent bc958c5 commit e10386d

File tree

5 files changed

+52
-10
lines changed

5 files changed

+52
-10
lines changed

studio/RData/Enums/CharFlags.vb

+10
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,19 @@ Namespace Flags
4747
Public Enum CharFlags
4848
HAS_HASH = 1
4949
BYTES = 1 << 1
50+
''' <summary>
51+
''' const LATIN1_MASK = (1&lt;&lt;2);
52+
''' </summary>
5053
LATIN1 = 1 << 2
54+
''' <summary>
55+
''' const UTF8_MASK = (1&lt;&lt;3);
56+
''' </summary>
5157
UTF8 = 1 << 3
5258
CACHED = 1 << 5
59+
60+
''' <summary>
61+
''' const ASCII_MASK = (1&lt;&lt;6);
62+
''' </summary>
5363
ASCII = 1 << 6
5464
End Enum
5565
End Namespace

studio/RData/Enums/FileTypes.vb

+15
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,25 @@ Namespace Flags
5252
Public Enum FileTypes
5353
Unknown = 0
5454

55+
''' <summary>
56+
''' bzip2 compression
57+
''' </summary>
5558
<Description("bz2")> bzip2
59+
''' <summary>
60+
''' gzip compression
61+
''' </summary>
5662
<Description("gzip")> gzip
63+
''' <summary>
64+
''' xz compression
65+
''' </summary>
5766
<Description("xz")> xz
67+
''' <summary>
68+
''' rdata version 2 (binary)
69+
''' </summary>
5870
<Description("rdata version 2 (binary)")> rdata_binary_v2
71+
''' <summary>
72+
''' rdata version 3 (binary)
73+
''' </summary>
5974
<Description("rdata version 3 (binary)")> rdata_binary_v3
6075
End Enum
6176
End Namespace

studio/RData/Enums/RObjectType.vb

+15-7
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ Namespace Flags
4949
''' </summary>
5050
Public Enum RObjectType As Byte
5151
''' <summary>
52-
''' NULL
52+
''' NULL, nil = NULL
5353
''' </summary>
5454
NIL = 0
5555
''' <summary>
5656
''' symbols
5757
''' </summary>
5858
SYM = 1
5959
''' <summary>
60-
''' pairlists
60+
''' pairlists, lists of dotted pairs
6161
''' </summary>
6262
LIST = 2
6363
''' <summary>
@@ -69,23 +69,23 @@ Namespace Flags
6969
''' </summary>
7070
ENV = 4
7171
''' <summary>
72-
''' promises
72+
''' promises, promises: [un]evaluated closure arguments
7373
''' </summary>
7474
PROM = 5
7575
''' <summary>
76-
''' language objects
76+
''' language objects, language constructs (special lists)
7777
''' </summary>
7878
LANG = 6
7979
''' <summary>
8080
''' special functions
8181
''' </summary>
8282
SPECIAL = 7
8383
''' <summary>
84-
''' builtin functions
84+
''' builtin functions, builtin non-special forms
8585
''' </summary>
8686
BUILTIN = 8
8787
''' <summary>
88-
''' internal character strings
88+
''' internal character strings, "scalar" string type (internal only)
8989
''' </summary>
9090
[CHAR] = 9
9191
''' <summary>
@@ -114,6 +114,9 @@ Namespace Flags
114114
DOT = 17
115115
''' <summary>
116116
''' make “any” args work
117+
'''
118+
''' Used in specifying types for symbol
119+
''' registration To mean anything Is okay
117120
''' </summary>
118121
ANY = 18
119122
''' <summary>
@@ -137,14 +140,19 @@ Namespace Flags
137140
''' </summary>
138141
WEAKREF = 23
139142
''' <summary>
140-
''' raw vector
143+
''' raw bytes vector
141144
''' </summary>
142145
RAW = 24
143146
''' <summary>
144147
''' S4 classes Not Of simple type
145148
''' </summary>
146149
S4 = 25
147150

151+
''' <summary>
152+
''' Closure or Builtin or Special
153+
''' </summary>
154+
FUNSXP = 99
155+
148156
''' <summary>
149157
''' Alternative representations
150158
''' </summary>

studio/RData/Enums/RdataFormats.vb

+10-1
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,22 @@ Imports System.ComponentModel
4747
Namespace Flags
4848

4949
''' <summary>
50-
''' Format of a R file.
50+
''' encoding format of a R file.
5151
''' </summary>
5252
Public Enum RdataFormats
5353
Unknown = 0
5454

55+
''' <summary>
56+
''' XDR encode
57+
''' </summary>
5558
<Description("XDR")> XDR
59+
''' <summary>
60+
''' ASCII encode
61+
''' </summary>
5662
<Description("ASCII")> ASCII
63+
''' <summary>
64+
''' binary encode
65+
''' </summary>
5766
<Description("binary")> binary
5867
End Enum
5968
End Namespace

studio/RData/RData.NET5.sln

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
Microsoft Visual Studio Solution File, Format Version 12.00
3-
# Visual Studio Version 16
4-
VisualStudioVersion = 16.0.31911.196
3+
# Visual Studio Version 17
4+
VisualStudioVersion = 17.1.32127.271
55
MinimumVisualStudioVersion = 10.0.40219.1
66
Project("{778DAE3C-4631-46EA-AA77-85C1314464D9}") = "RData.NET5", "RData.NET5.vbproj", "{35E5BBE9-B096-46D9-8F04-4E759788EB44}"
77
EndProject

0 commit comments

Comments
 (0)