fbdoc: wiki snapshot 2018-09-02

Author: jayrm

doc/manual/cache/CatPgFullIndex.wakka

@@ -213,7 +213,7 @@ Alphabetical listing of keywords, macros and procedures.
 	- {{fbdoc item="keyword" value="KeyPgDefuint|DEFUINT"}}
 	- {{fbdoc item="keyword" value="KeyPgDefulongint|DEFULONGINT"}}
 	- {{fbdoc item="keyword" value="KeyPgDefushort|DEFUSHORT"}}
-	- {{fbdoc item="keyword" value="KeyPgOpDelete|DELETE"}}
+	- {{fbdoc item="keyword" value="KeyPgOpDelete|DELETE (Statement)"}}
 	- {{fbdoc item="keyword" value="KeyPgDestructor|DESTRUCTOR"}}
 	- {{fbdoc item="keyword" value="KeyPgModuleDestructor|DESTRUCTOR (Module)"}}
 	- {{fbdoc item="keyword" value="KeyPgDim|DIM"}}
@@ -367,7 +367,7 @@ Alphabetical listing of keywords, macros and procedures.
 	- {{fbdoc item="keyword" value="KeyPgNaked|NAKED"}}
 	- {{fbdoc item="keyword" value="KeyPgName|NAME"}}
 	- {{fbdoc item="keyword" value="KeyPgNamespace|NAMESPACE"}}
-	- {{fbdoc item="keyword" value="KeyPgOpNew|NEW"}}
+	- {{fbdoc item="keyword" value="KeyPgOpNew|NEW (Expression)"}}
 	- {{fbdoc item="keyword" value="KeyPgOpPlacementNew|NEW (Placement)"}}
 	- {{fbdoc item="keyword" value="KeyPgNext|NEXT"}}
 	- {{fbdoc item="keyword" value="KeyPgResumenext|NEXT (RESUME)"}}

doc/manual/cache/CatPgOpIndex.wakka

@@ -84,9 +84,11 @@ List of operators used in FreeBASIC.
 	- {{fbdoc item="keyword" value="KeyPgOpIs|IS (Run-time type information operator)"}}
 
 {{fbdoc item="section" value="Memory Operators"}}
-	- {{fbdoc item="keyword" value="KeyPgOpNew|New"}}
+	- {{fbdoc item="keyword" value="KeyPgOpNew|New Expression"}}
+		- {{fbdoc item="keyword" value="KeyPgOpNewOverload|New Overload"}}
 	- {{fbdoc item="keyword" value="KeyPgOpPlacementNew|Placement New"}}
-	- {{fbdoc item="keyword" value="KeyPgOpDelete|Delete"}}
+	- {{fbdoc item="keyword" value="KeyPgOpDelete|Delete Statement"}}
+		- {{fbdoc item="keyword" value="KeyPgOpDeleteOverload|Delete Overload"}}
 
 {{fbdoc item="section" value="Iteration Operators"}}
 	- {{fbdoc item="keyword" value="KeyPgOpFor|For"}}, [[KeyPgOpNext|Next]], and [[KeyPgOpStep|Step]]

doc/manual/cache/CatPgOpMemory.wakka

@@ -3,12 +3,15 @@ Operators that work with memory
 
 The memory operators provide a way to dynamically allocate and deallocate variables and objects.
 
-<<=={{fbdoc item="keyword" value="KeyPgOpNew|Operator New"}}==
+<<=={{fbdoc item="keyword" value="KeyPgOpNew|Operator New Expression"}}==
 	Allocates memory for and constructs objects.
+	=={{fbdoc item="keyword" value="KeyPgOpNewOverload|Operator New Overload"}}==
+		Overloads memory allocation process of Operator New Expression when applying to UDT.
 =={{fbdoc item="keyword" value="KeyPgOpPlacementNew|Operator Placement New"}}==
 	Constructs objects at a specified memory location.
-<<>>=={{fbdoc item="keyword" value="KeyPgOpDelete|Operator Delete"}}==
+<<>>=={{fbdoc item="keyword" value="KeyPgOpDelete|Operator Delete Statement"}}==
 	Destroys and deallocates memory for objects.
->>::c::
+	=={{fbdoc item="keyword" value="KeyPgOpDeleteOverload|Operator Delete Overload"}}==
+		Overloads memory deallocation process of Operator Delete Statement when applying to UDT.>>::c::
 
 {{fbdoc item="back" value="CatPgOperators|Operators"}}

doc/manual/cache/CatPgVariables.wakka

@@ -1,19 +1,19 @@
 {{fbdoc item="title" value="Variable Declarations"}}----
 Statements to declare and allocate space for variables.
 
-<<=={{fbdoc item="keyword" value="KeyPgDim|DIM"}}==
+<<**{{fbdoc item="keyword" value="KeyPgDim|DIM"}}**
 	Declares a variable at the current scope.
-=={{fbdoc item="keyword" value="KeyPgConst|CONST"}}==
+**{{fbdoc item="keyword" value="KeyPgConst|CONST"}}**
 	Declares a non-modifiable variable.
-=={{fbdoc item="keyword" value="KeyPgScope|SCOPE"}}==
+**{{fbdoc item="keyword" value="KeyPgScope|SCOPE"}}**
 	Begins a new scope block.
-=={{fbdoc item="keyword" value="KeyPgStatic|STATIC"}}==
+**{{fbdoc item="keyword" value="KeyPgStatic|STATIC"}}**
 	Declares variables in a procedure that retain their value between calls.
-<<>>=={{fbdoc item="keyword" value="KeyPgShared|SHARED"}}==
+<<>>**{{fbdoc item="keyword" value="KeyPgShared|SHARED"}}**
 	Used with ##[[KeyPgDim|Dim]]## allows variables to be visible throughout a module.
-=={{fbdoc item="keyword" value="KeyPgVar|VAR"}}==
+**{{fbdoc item="keyword" value="KeyPgVar|VAR"}}**
 	Declares variables where the data type is implied from an initializer.
-=={{fbdoc item="keyword" value="KeyPgByrefVariables|BYREF (variables)"}}==
+**{{fbdoc item="keyword" value="KeyPgByrefVariables|BYREF (variables)"}}**
 	Used with ##[[KeyPgDim|Dim]]## or ##[[KeyPgStatic|Static]]## or ##[[KeyPgVar|Var]]## allows to declare references.
 >>
 

doc/manual/cache/CompilerCmdLine.wakka

@@ -132,7 +132,7 @@ Using the **fbc** command-line.
 	=={{fbdoc item="keyword" value="CompilerOptcupp|-C"}}==
 		Do not delete the object file(s)
 	=={{fbdoc item="keyword" value="CompilerOptw|-w < value >"}}==
-		Set min warning level: ##all##, ##pedantic##, ##next## or a value
+		Set min warning level: ##all##, ##param##, ##escape##, ##pedantic##, ##next##, ##constness## or a value
 	=={{fbdoc item="keyword" value="CompilerOptmaxerr|-maxerr < val >"}}==
 		Only stop parsing if <val> errors occurred
 	=={{fbdoc item="keyword" value="CompilerOptnoerrline|-noerrline"}}==

doc/manual/cache/CompilerOptw.wakka

@@ -2,7 +2,7 @@
 Set minimum warning level.
 
 {{fbdoc item="syntax"}}##
-	**-w** //level// | **all** | **param** | **escape** | **pedantic** | **next**
+	**-w** //level// | **all** | **param** | **escape** | **pedantic** | **next** | **constness**
 ##
 {{fbdoc item="param"}}
 	##//level//##
@@ -17,11 +17,13 @@ Set minimum warning level.
 		Equivalent to specifying the ##**param**## and ##**escape**## arguments, plus length checking of parameters passed ##[[KeyPgByval|ByVal]]## and of any ##[[KeyPgCptr|Cptr]]## converting to pointer only.
 	##**next**##
 		Warn when ##[[KeyPgNext|Next]]## is followed by an identifier.
+	##**constness**##
+		Warn when ##[[KeyPgConstQualifier|CONST (Qualifier)]]## is discarded in an assignment.
 
 {{fbdoc item="desc"}}
 	The ##-w## compiler option determines which compiler warnings, if any, are output. Each possible warning is associated with a warning level, starting from zero (##0##) and increasing with the potential problems that may occur. A significantly high ##//level//## value will have the effect of suppressing all warning messages.
 
-	Note that the ##**param**##, ##**escape**##, ##**pedantic**## and ##**next**## arguments provide additional warnings not ordinarily output, even by default.
+	Note that the ##**param**##, ##**escape**##, ##**pedantic**##, ##**next**## and ##**constness**## arguments provide additional warnings not ordinarily output, even by default.
 
 	If the ##**-w**## option is not specified, it's as if ##**-w 0**## was used. The ##**-w**## option can be specified multiple times.
 

doc/manual/cache/GlossaryIndex.wakka

@@ -130,7 +130,7 @@ Brief definitions and explanations for words and phrases used in the ""FreeBASIC
 	Refers to the internal data structure used by the compiler and runtime library for managing variable length strings and arrays.
 
 **destroy (TYPE or CLASS)**
-	The act of deconstructing and deallocating memory for an object instance. When an object is destroyed, its destructor is called. This happens automatically when an object goes out of scope, or when ##[[KeyPgOpDelete|Delete]]## is called with a pointer to an object.
+	The act of deconstructing and deallocating memory for an object instance. When an object is destroyed, its destructor is called. This happens automatically when an object goes out of scope, or when ##[[KeyPgOpDelete|Delete (Statement)]]## is called with a pointer to an object.
 
 **destructor (module)**
 	A special type of module-level procedure that is automatically called at program termination. See ##[[KeyPgModuleDestructor|Destructor (Module)]]##.

doc/manual/cache/KeyPgAllocate.wakka

@@ -17,7 +17,7 @@ Allocates a block of memory from the free store
 {{fbdoc item="desc"}}
 	Attempts to allocate, or reserve, ##//count//## number of bytes from the free store (heap). The newly allocated memory is not initialized.
 
-	As the initial value of newly allocated memory is unspecified, **Allocate** must not be directly used with ##[[KeyPgString|String]]## or ##[[KeyPgType|UDT]]## containing string, because the string descriptor being not cleared (containing random data), that may induce corrupted string or more (trying to write to a random place in memory or trying to deallocate a random pointer).  It is mandatory in that case (with string or UDT containing string) to use ##[[KeyPgCallocate|Callocate]]## (clearing memory), or ##[[KeyPgOpNew|New]]## (calling constructor) in case of **UDT**, or at worst after **Allocate** to explicitly clear the descriptor (setting to 0) before the first string use.
+	As the initial value of newly allocated memory is unspecified, **Allocate** must not be directly used with ##[[KeyPgString|String]]## or ##[[KeyPgType|UDT]]## containing string, because the string descriptor being not cleared (containing random data), that may induce corrupted string or more (trying to write to a random place in memory or trying to deallocate a random pointer).  It is mandatory in that case (with string or UDT containing string) to use ##[[KeyPgCallocate|Callocate]]## (clearing memory), or ##[[KeyPgOpNew|New Expression]]## (calling constructor) in case of **UDT**, or at worst after **Allocate** to explicitly clear the descriptor (setting to 0) before the first string use.
 
 	The pointer that is returned is an [[KeyPgAny|any]] [[KeyPgPtr|ptr]] and points to the start of the allocated memory. This pointer is guaranteed to be unique, even if ##//count//## is zero.
 

doc/manual/cache/KeyPgAny.wakka

@@ -41,7 +41,7 @@ The ##**Any**## keyword is used as a placeholder for a type or value in various
 
 		Comparison to ""C/C++"": This matches the behavior of a variable declaration without initialization value in ""C/C++"".
 
-		Similar to **##Any##** initializers for variables, **##Any##** can also be used with the ##[[KeyPgOpNew|New]]## or ##[[KeyPgOpPlacementNew|Placement New]]## operators in order to leave the newly created object uninitialized (only allowed with data types that do not have constructors).
+		Similar to **##Any##** initializers for variables, **##Any##** can also be used with the ##[[KeyPgOpNew|New Expression]]## or ##[[KeyPgOpPlacementNew|Placement New]]## operators in order to leave the newly created object uninitialized (only allowed with data types that do not have constructors).
 
 	- ""Instr/InstrRev"":
 		**##Any##** can be used with ##[[KeyPgInstr|Instr]]## or ##[[KeyPgInstrrev|InstrRev]]## as a qualifier for the ##//substring//## parameter, to indicate that any individual character in it may be matched.

doc/manual/cache/KeyPgConstructor.wakka

@@ -24,7 +24,7 @@ Called automatically when a class or user defined type is created
 
 	A constructor method is passed a hidden ##[[KeyPgThis|this]]## parameter having the same type as ##//typename//##.  ##[[KeyPgThis|this]]## is optionally used to access the fields of the ##[[KeyPgType|Type]]## or ##[[KeyPgClass|Class]]## which is to be initialized in the ##**Constructor**## method.
 
-	Constructors are called when declaring global or local static instances of ##//typename//## and when allocating ##//typename//## dynamically using the ##[[KeyPgOpNew|New]]## operator. See examples below for different constructor syntaxes.
+	Constructors are called when declaring global or local static instances of ##//typename//## and when allocating ##//typename//## dynamically using the ##[[KeyPgOpNew|New Expression]]## operator. See examples below for different constructor syntaxes.
 
 	A copy ##**Constructor**## is a special constructor that initializes a new object from an existing object. There are three general cases where the copy ##**Constructor**## is called: when instantiating one object and initializing it with another object (in one instruction), when passing an object by value, when an object is returned from a function by value (by using ##[[KeyPgReturn|Return]] //x//## statement).
 		Note: When an object is returned from a function by value, but by using ##**Function** = //x//## (or ##//function_identifier// = //x//##) assignment, the ##**Constructor**## is called once at first, and then the ##[[KeyPgOpLet|Let (Assign)]]## operator at each assignment.
@@ -189,7 +189,7 @@ Sleep
 {{fbdoc item="see"}}
 	- ##[[KeyPgClass|Class]]##
 	- ##[[KeyPgModuleConstructor|Constructor (Module)]]##
-	- ##[[KeyPgOpNew|New]]##
+	- ##[[KeyPgOpNew|New Expression]]##
 	- ##[[KeyPgDestructor|Destructor]]##
 	- ##[[KeyPgType|Type]]##
 	- [[ProPgDataConversion|Coercion and Conversion]]