Skip to content

Commit c0fdfeb

Browse files
jayrmjayrm
authored
Merge pull request #95 from jayrm/manual-aug-2018
fbdoc Update Aug 2018
2 parents fcb253f + e4194ce commit c0fdfeb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+2031
-792
lines changed

‎doc/fbchkdoc/mkerrlst.bas‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,14 @@ end sub
3131
''
3232
sub WriteFooterCode( byval h as integer )
3333
print #h, !"print"
34+
print #h, !"dim msg as string"
3435
print #h, !"for i as integer = 1 to FB_WARNINGMSGS-1"
35-
print #h, !"print chr(9) + \"- //\" + ltrim(str(i)) + \" \" + *warningMsgs(i).text + \"//\""
36+
print #h, !"if i = FB_WARNINGMSG_AMBIGIOUSLENSIZEOF then"
37+
print #h, !"msg = ""Ambiguous LEN or SIZEOF"""
38+
print #h, !"else"
39+
print #h, !"msg = *warningMsgs(i).text"
40+
print #h, !"end if"
41+
print #h, !"print chr(9) + \"- //\" + ltrim(str(i)) + \" \" + msg + \"//\""
3642
print #h, !"next"
3743
print #h, !"print: print: print"
3844
print #h, !"for i as integer = 1 to FB_ERRMSGS-1"

‎doc/manual/cache/CatPgFullIndex.wakka‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Alphabetical listing of keywords, macros and procedures.
213213
- {{fbdoc item="keyword" value="KeyPgDefuint|DEFUINT"}}
214214
- {{fbdoc item="keyword" value="KeyPgDefulongint|DEFULONGINT"}}
215215
- {{fbdoc item="keyword" value="KeyPgDefushort|DEFUSHORT"}}
216-
- {{fbdoc item="keyword" value="KeyPgOpDelete|DELETE"}}
216+
- {{fbdoc item="keyword" value="KeyPgOpDelete|DELETE (Statement)"}}
217217
- {{fbdoc item="keyword" value="KeyPgDestructor|DESTRUCTOR"}}
218218
- {{fbdoc item="keyword" value="KeyPgModuleDestructor|DESTRUCTOR (Module)"}}
219219
- {{fbdoc item="keyword" value="KeyPgDim|DIM"}}
@@ -273,6 +273,7 @@ Alphabetical listing of keywords, macros and procedures.
273273
- {{fbdoc item="keyword" value="KeyPgFreefile|FREEFILE"}}
274274
- {{fbdoc item="keyword" value="KeyPgFunction|FUNCTION"}}
275275
- {{fbdoc item="keyword" value="KeyPgMemberFunction|FUNCTION (Member)"}}
276+
- {{fbdoc item="keyword" value="KeyPgFunctionPtr|FUNCTION (Pointer)"}}
276277

277278
{{fbdoc item="section" value="G"}}{{anchor name="g"}}
278279
- {{fbdoc item="keyword" value="KeyPgGetgraphics|GET (Graphics)"}}
@@ -367,7 +368,7 @@ Alphabetical listing of keywords, macros and procedures.
367368
- {{fbdoc item="keyword" value="KeyPgNaked|NAKED"}}
368369
- {{fbdoc item="keyword" value="KeyPgName|NAME"}}
369370
- {{fbdoc item="keyword" value="KeyPgNamespace|NAMESPACE"}}
370-
- {{fbdoc item="keyword" value="KeyPgOpNew|NEW"}}
371+
- {{fbdoc item="keyword" value="KeyPgOpNew|NEW (Expression)"}}
371372
- {{fbdoc item="keyword" value="KeyPgOpPlacementNew|NEW (Placement)"}}
372373
- {{fbdoc item="keyword" value="KeyPgNext|NEXT"}}
373374
- {{fbdoc item="keyword" value="KeyPgResumenext|NEXT (RESUME)"}}
@@ -516,6 +517,7 @@ Alphabetical listing of keywords, macros and procedures.
516517
- {{fbdoc item="keyword" value="KeyPgOpStrptr|STRPTR"}}
517518
- {{fbdoc item="keyword" value="KeyPgSub|SUB"}}
518519
- {{fbdoc item="keyword" value="KeyPgMemberSub|SUB (Member)"}}
520+
- {{fbdoc item="keyword" value="KeyPgSubPtr|SUB (Pointer)"}}
519521
- {{fbdoc item="keyword" value="KeyPgSwap|SWAP"}}
520522
- {{fbdoc item="keyword" value="KeyPgSystem|SYSTEM"}}
521523

‎doc/manual/cache/CatPgFunctIndex.wakka‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
7474
- {{fbdoc item="keyword" value="KeyPgDouble|DOUBLE"}}
7575
- {{fbdoc item="keyword" value="KeyPgEnum|ENUM"}}
7676
- {{fbdoc item="keyword" value="KeyPgExtends|EXTENDS"}}
77+
- {{fbdoc item="keyword" value="KeyPgFunctionPtr|FUNCTION (Pointer)"}}
7778
- {{fbdoc item="keyword" value="KeyPgImplements|IMPLEMENTS"}}
7879
- {{fbdoc item="keyword" value="KeyPgInteger|INTEGER"}}
7980
- {{fbdoc item="keyword" value="KeyPgLong|LONG"}}
@@ -85,6 +86,7 @@ List of ""FreeBASIC"" keywords sorted by the function they perform.
8586
- {{fbdoc item="keyword" value="KeyPgSingle|SINGLE"}}
8687
- {{fbdoc item="keyword" value="KeyPgStatic|STATIC"}}
8788
- {{fbdoc item="keyword" value="KeyPgString|STRING"}}
89+
- {{fbdoc item="keyword" value="KeyPgSubPtr|SUB (Pointer)"}}
8890
- {{fbdoc item="keyword" value="KeyPgType|TYPE"}}
8991
- {{fbdoc item="keyword" value="KeyPgTypeAlias|TYPE (Alias)"}}
9092
- {{fbdoc item="keyword" value="KeyPgTypeTemp|TYPE (Temporary)"}}

‎doc/manual/cache/CatPgMemory.wakka‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ Procedures that work with static and dynamic memory.
2828
=={{fbdoc item="keyword" value="KeyPgSwap|SWAP"}}==
2929
Exchange the contents of two variables.
3030
=={{fbdoc item="keyword" value="KeyPgSadd|SADD"}}==
31-
Returns the address for the data in a string variable.
31+
Returns the address for the data in a zstring variable.
3232
>>::c::
33+
{{fbdoc item="see"}}
34+
- [[CatPgOpMemory|Memory Operators]]
3335

3436
{{fbdoc item="back" value="DocToc|Table of Contents"}}

‎doc/manual/cache/CatPgOpIndex.wakka‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,11 @@ List of operators used in FreeBASIC.
8484
- {{fbdoc item="keyword" value="KeyPgOpIs|IS (Run-time type information operator)"}}
8585

8686
{{fbdoc item="section" value="Memory Operators"}}
87-
- {{fbdoc item="keyword" value="KeyPgOpNew|New"}}
87+
- {{fbdoc item="keyword" value="KeyPgOpNew|New Expression"}}
88+
- {{fbdoc item="keyword" value="KeyPgOpNewOverload|New Overload"}}
8889
- {{fbdoc item="keyword" value="KeyPgOpPlacementNew|Placement New"}}
89-
- {{fbdoc item="keyword" value="KeyPgOpDelete|Delete"}}
90+
- {{fbdoc item="keyword" value="KeyPgOpDelete|Delete Statement"}}
91+
- {{fbdoc item="keyword" value="KeyPgOpDeleteOverload|Delete Overload"}}
9092

9193
{{fbdoc item="section" value="Iteration Operators"}}
9294
- {{fbdoc item="keyword" value="KeyPgOpFor|For"}}, [[KeyPgOpNext|Next]], and [[KeyPgOpStep|Step]]

‎doc/manual/cache/CatPgOpMemory.wakka‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,15 @@ Operators that work with memory
33

44
The memory operators provide a way to dynamically allocate and deallocate variables and objects.
55

6-
<<=={{fbdoc item="keyword" value="KeyPgOpNew|Operator New"}}==
6+
<<=={{fbdoc item="keyword" value="KeyPgOpNew|Operator New Expression"}}==
77
Allocates memory for and constructs objects.
8+
=={{fbdoc item="keyword" value="KeyPgOpNewOverload|Operator New Overload"}}==
9+
Overloads memory allocation process of Operator New Expression when applying to UDT.
810
=={{fbdoc item="keyword" value="KeyPgOpPlacementNew|Operator Placement New"}}==
911
Constructs objects at a specified memory location.
10-
<<>>=={{fbdoc item="keyword" value="KeyPgOpDelete|Operator Delete"}}==
12+
<<>>=={{fbdoc item="keyword" value="KeyPgOpDelete|Operator Delete Statement"}}==
1113
Destroys and deallocates memory for objects.
12-
>>::c::
14+
=={{fbdoc item="keyword" value="KeyPgOpDeleteOverload|Operator Delete Overload"}}==
15+
Overloads memory deallocation process of Operator Delete Statement when applying to UDT.>>::c::
1316

1417
{{fbdoc item="back" value="CatPgOperators|Operators"}}

‎doc/manual/cache/CatPgStdDataTypes.wakka‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Built-in data types
77
Types that store real number values, whose range and precision is determined by the size of the data type.
88
**{{anchor name="BOOLEAN|Boolean types"}}**
99
Types that store boolean values.
10+
**{{anchor name="PROCTYPES|Procedure Types"}}**
11+
Types that store pointers to procedures
1012
**{{anchor name="MODIFIERS|Data Type Modifiers"}}**
1113
Specifies additional characteristics of a standard or user-defined data type.
1214
**{{anchor name="STRING|String types"}}**
@@ -35,6 +37,12 @@ Built-in data types
3537
{{anchor name="BOOLEAN"}}{{fbdoc item="section" value="Boolean types"}}
3638
=={{fbdoc item="keyword" value="KeyPgBoolean|BOOLEAN"}}==
3739
1-bit wide data types that store boolean values.
40+
41+
{{anchor name="PROCTYPES"}}{{fbdoc item="section" value="Procedure Types"}}
42+
=={{fbdoc item="keyword" value="KeyPgFunctionPtr|FUNCTION Pointer"}}==
43+
Types that store a pointer to a function procedure
44+
=={{fbdoc item="keyword" value="KeyPgSubPtr|SUB Pointer"}}==
45+
Types that store a pointer to a sub procedure
3846
<<>>{{anchor name="MODIFIERS"}}{{fbdoc item="section" value="Data Type Modifiers"}}
3947
=={{fbdoc item="keyword" value="KeyPgConstQualifier|CONST"}}==
4048
Specifies a read only type.

‎doc/manual/cache/CatPgUserDefTypes.wakka‎

Lines changed: 71 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,79 @@
11
{{fbdoc item="title" value="User Defined Types"}}----
22

3-
<<{{fbdoc item="section" value="Declaration"}}
4-
- {{fbdoc item="keyword" value="KeyPgEnum|ENUM...END ENUM"}}
5-
- {{fbdoc item="keyword" value="KeyPgType|TYPE...END TYPE"}}
6-
- {{fbdoc item="keyword" value="KeyPgClass|CLASS...END CLASS"}}
7-
- {{fbdoc item="keyword" value="KeyPgUnion|UNION...END UNION"}}
8-
- {{fbdoc item="keyword" value="KeyPgExtends|EXTENDS"}}
9-
- {{fbdoc item="keyword" value="KeyPgImplements|IMPLEMENTS"}}
10-
- {{fbdoc item="keyword" value="KeyPgField|FIELD"}}
11-
- {{fbdoc item="keyword" value="KeyPgObject|OBJECT"}}
3+
**{{anchor name="DECLARATION|Declaration"}}**
4+
Declaring and describing user defined types
5+
**{{anchor name="REFERENCING|Referencing"}}**
6+
Accessing data in a user defined type
7+
**{{anchor name="MEMBERPROC|Member Procedures"}}**
8+
Declaring and defining methods related to a user defined type
9+
**{{anchor name="MEMBERACCESS|Member Access Control"}}**
10+
Controlling when data and member procedures are accessed
1211

13-
{{fbdoc item="section" value="Referencing"}}
14-
- {{fbdoc item="keyword" value="KeyPgTypeTemp|Temporary Types"}}
15-
- {{fbdoc item="keyword" value="KeyPgThis|THIS"}}
16-
- {{fbdoc item="keyword" value="KeyPgBase|BASE (member access)"}}
17-
- {{fbdoc item="keyword" value="KeyPgTypeAlias|Type Alias"}}
18-
- {{fbdoc item="keyword" value="KeyPgWith|WITH"}}
19-
<<>>{{fbdoc item="section" value="Member Procedures"}}
20-
- {{fbdoc item="keyword" value="KeyPgBaseInit|BASE (initialization)"}}
21-
- {{fbdoc item="keyword" value="KeyPgConstructor|CONSTRUCTOR"}}
22-
- {{fbdoc item="keyword" value="KeyPgDestructor|DESTRUCTOR"}}
23-
- {{fbdoc item="keyword" value="KeyPgMemberFunction|FUNCTION"}}
24-
- {{fbdoc item="keyword" value="KeyPgOperator|OPERATOR"}}
25-
- {{fbdoc item="keyword" value="KeyPgOverride|OVERRIDE"}}
26-
- {{fbdoc item="keyword" value="KeyPgProperty|PROPERTY"}}
27-
- {{fbdoc item="keyword" value="KeyPgMemberSub|SUB"}}
28-
- {{fbdoc item="keyword" value="KeyPgStaticMember|STATIC (Member)"}}
29-
- {{fbdoc item="keyword" value="KeyPgVirtual|VIRTUAL"}}
30-
- {{fbdoc item="keyword" value="KeyPgAbstract|ABSTRACT"}}
31-
- {{fbdoc item="keyword" value="KeyPgConstMember|CONST (Member)"}}
12+
<<{{anchor name="DECLARATION"}}{{fbdoc item="section" value="Declarations"}}
13+
=={{fbdoc item="keyword" value="KeyPgEnum|ENUM...END ENUM"}}==
14+
User defined enumeration of values
15+
=={{fbdoc item="keyword" value="KeyPgType|TYPE...END TYPE"}}==
16+
User defined structure of non overlapping data and member procedures
17+
=={{fbdoc item="keyword" value="KeyPgClass|CLASS...END CLASS"}}==
18+
Not implemented. Keyword reserved.
19+
=={{fbdoc item="keyword" value="KeyPgUnion|UNION...END UNION"}}==
20+
User defined structure of overlapping data
21+
=={{fbdoc item="keyword" value="KeyPgExtends|EXTENDS"}}==
22+
Extends an user defined type to derive another
23+
=={{fbdoc item="keyword" value="KeyPgImplements|IMPLEMENTS"}}==
24+
Not implemented. Keyword reserved.
25+
=={{fbdoc item="keyword" value="KeyPgField|FIELD"}}==
26+
Specifies field alignment within a user defined type
27+
=={{fbdoc item="keyword" value="KeyPgObject|OBJECT"}}==
28+
Built-in type providing run-time type information
3229

33-
{{fbdoc item="section" value="Member Access Control"}}
34-
- {{fbdoc item="keyword" value="KeyPgVisPublic|PUBLIC: (Access Control)"}}
35-
- {{fbdoc item="keyword" value="KeyPgVisPrivate|PRIVATE: (Access Control)"}}
36-
- {{fbdoc item="keyword" value="KeyPgVisProtected|PROTECTED: (Access Control)"}}
30+
{{anchor name="REFERENCING"}}{{fbdoc item="section" value="Referencing"}}
31+
=={{fbdoc item="keyword" value="KeyPgTypeTemp|Temporary Types"}}==
32+
Creates a temporary copy of a user defined type
33+
=={{fbdoc item="keyword" value="KeyPgThis|THIS"}}==
34+
Built-in, hidden, parameter passed to non-static member procedures to access the user defined type instance
35+
=={{fbdoc item="keyword" value="KeyPgBase|BASE (member access)"}}==
36+
Built-in, hidden, variable to access the base user defined type instance in derived user defined types
37+
=={{fbdoc item="keyword" value="KeyPgTypeAlias|Type Alias"}}==
38+
Declares a user defined type from other user defined or standard data types
39+
=={{fbdoc item="keyword" value="KeyPgWith|WITH"}}==
40+
Compound statement to access the data and members of a user defined type
41+
42+
<<>>{{anchor name="MEMBERPROC"}}{{fbdoc item="section" value="Member Procedures"}}
43+
=={{fbdoc item="keyword" value="KeyPgBaseInit|BASE (initialization)"}}==
44+
Specifies an initializer for the base user defined type in derived user defined type constructors
45+
=={{fbdoc item="keyword" value="KeyPgConstructor|CONSTRUCTOR"}}==
46+
Declares or defines a member procedure that is automatically called when a user defined type is created
47+
=={{fbdoc item="keyword" value="KeyPgDestructor|DESTRUCTOR"}}==
48+
Declares or defines a member procedure that is automatically called when a user defined type is destroyed or goes out of scope
49+
=={{fbdoc item="keyword" value="KeyPgMemberFunction|FUNCTION"}}==
50+
Declares or defines a member procedure returning a value
51+
=={{fbdoc item="keyword" value="KeyPgOperator|OPERATOR"}}==
52+
Declares or defines an overloaded operator
53+
=={{fbdoc item="keyword" value="KeyPgOverride|OVERRIDE"}}==
54+
Member method attribute that specifies that the method is expected to override a virtual method in the base user defined type
55+
=={{fbdoc item="keyword" value="KeyPgProperty|PROPERTY"}}==
56+
Declares or defines property member procedures for a user defined type
57+
=={{fbdoc item="keyword" value="KeyPgMemberSub|SUB"}}==
58+
Declare or defines a member procedure
59+
=={{fbdoc item="keyword" value="KeyPgStaticMember|STATIC (Member)"}}==
60+
Declares or defines a member procedure or variable is static
61+
=={{fbdoc item="keyword" value="KeyPgVirtual|VIRTUAL"}}==
62+
Member method attribute that declares that a member must have an implementation
63+
=={{fbdoc item="keyword" value="KeyPgAbstract|ABSTRACT"}}==
64+
Member method attribute that declares that a member must be implemented in a derived user defined type
65+
=={{fbdoc item="keyword" value="KeyPgConstMember|CONST (Member)"}}==
66+
Member method attribute that declares or defines that the method is readonly and does not modify the user defined types's data
67+
68+
{{anchor name="MEMBERACCESS"}}{{fbdoc item="section" value="Member Access Control"}}
69+
=={{fbdoc item="keyword" value="KeyPgVisPublic|PUBLIC: (Access Control)"}}==
70+
Data and members in a user defined type have public visibility
71+
=={{fbdoc item="keyword" value="KeyPgVisPrivate|PRIVATE: (Access Control)"}}==
72+
Data and members in a user defined type have private visibility
73+
=={{fbdoc item="keyword" value="KeyPgVisProtected|PROTECTED: (Access Control)"}}==
74+
Data and members in a user defined type have protected visibility
3775
>>
3876

3977
::c::
4078

41-
{{fbdoc item="back" value="DocToc|Table of Contents"}}
42-
43-
44-
45-
79+
{{fbdoc item="back" value="DocToc|Table of Contents"}}

‎doc/manual/cache/CompilerCmdLine.wakka‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Using the **fbc** command-line.
132132
=={{fbdoc item="keyword" value="CompilerOptcupp|-C"}}==
133133
Do not delete the object file(s)
134134
=={{fbdoc item="keyword" value="CompilerOptw|-w < value >"}}==
135-
Set min warning level: ##all##, ##pedantic##, ##next## or a value
135+
Set min warning level: ##all##, ##param##, ##escape##, ##pedantic##, ##next##, ##constness## or a value
136136
=={{fbdoc item="keyword" value="CompilerOptmaxerr|-maxerr < val >"}}==
137137
Only stop parsing if <val> errors occurred
138138
=={{fbdoc item="keyword" value="CompilerOptnoerrline|-noerrline"}}==

0 commit comments

Comments
 (0)