diff --git a/docs/xml/lazutils/lazloggerbase.xml b/docs/xml/lazutils/lazloggerbase.xml index 019c22ca7d..83301991f9 100644 --- a/docs/xml/lazutils/lazloggerbase.xml +++ b/docs/xml/lazutils/lazloggerbase.xml @@ -1508,16 +1508,24 @@ enable/disable them, as it discards all logging anyway. -Writes a message to the log. + +Writes a message to the log. +

-Calls the DebuglnStack method for the logger class instance. +Calls the DebugLnStack method for the logger class instance.

- + + + + +
- + +Message written to the debugger output. + @@ -1525,20 +1533,24 @@ Calls the DebuglnStack method for the logger class instance. Writes a message to the log.

-Writes the text to the log. Does not append a new line. +Writes the text to the log. Does not append an end-of-line sequence. The Argument can be:

-This is a forwarder to the log TLazLogger object. See there for details. +This routine forwards output operations to the DbgOut method in a TLazLogger +class instance.

+ + + GetDebugLogger SetDebugLogger @@ -1547,7 +1559,9 @@ This is a forwarder to the log TLazLogger object. See there for details. String argument for the routine. - + +Array of constant values written to the debugger output. + String argument for the routine. @@ -1605,22 +1619,32 @@ This is a forwarder to the log TLazLogger object. See there for details. -Writes a message to the log. + +Writes a message to the debugger output followed by an end-of-line sequence. +

-Writes the text to the log. Does append a new line. +Writes the text to the log. Appends an end-of-line sequence after values are +written.

-The Argument can be: +The Argument(s) can be:

-

This is a forwarder to the log TLazLogger object. See there for -details.

+

+DebugLn forwards the output operation to the DebugLn method in a TLazlogger +instance. +

GetDebugLogger @@ -1631,7 +1655,9 @@ details.

String argument for the routine.
- + +Array of constant values converted to a string and written in the routine. + String argument for the routine. @@ -1689,11 +1715,14 @@ details.

-Writes a message to the log. + +Writes a message line to the log and increases the indentation level. +

-Writes the text to the log. Does append a new line. Increases the current -intend. +Writes the specified values text to the debugger output. Appends an end-of-line +sequence to the end of the values. Increases the current indentation level +after the value(s) are written to the debugger output.

The Argument can be: @@ -1716,7 +1745,10 @@ details.

String argument for the routine.
- + +Array of constant values converted to strings, joined, and written in the +routine. + String argument for the routine. @@ -1774,7 +1806,7 @@ details.

-Writes a message to the log. +Writes a message line to the debugger .

Writes the text to the log. Does append a new line. Increases the current @@ -1784,15 +1816,18 @@ indentation level. The Argument can be:

+

+DebugLnExit forwards the output operation to the DebugLnExit method in a +TLazLogger class instance. +

+ GetDebugLogger SetDebugLogger @@ -1801,7 +1836,10 @@ details. String argument for the routine.
- + +Array of constant values converted to strings, joined, and output in the +routine. + String argument for the routine. @@ -1861,14 +1899,16 @@ details. -Generates a debugger message formatted with the value(s) for the specified +Generates a formatted debugger message with the value(s) for the specified type(s). +

+DbgS is used to implement the ArgsToString method in TLazLogger. +

- - +
@@ -1902,7 +1942,9 @@ type(s). TMethod value for the message. - + +TSize instance with the cx and cy values for the message. + String value for the message. @@ -1926,15 +1968,21 @@ type(s). -Generates a debugger message with the combined values of the specified +Generates a debugger message with the combined values for the specified string arguments. - - + +DbgSJoin is used to implement the DbgS routine for enumeration values in a set +type. + + + + -Message with the values in s1 and s2 combined into a single string. +Message with the values in s1 and s2 combined into a comma-separated string +value. @@ -2040,15 +2088,14 @@ Generates a message with the tick count for the computer system. Generates a message with the hexadecimal-encoded content for the specified block of memory and size. - - - - - - + + - + +String with the contents from the specified memory block formatted as +hexadecimal characters. + Untyped pointer to the byte values examined in the routine. @@ -2070,20 +2117,31 @@ Generates a message with the hexadecimal-encoded values from the specified memory stream. +

+Reads the content from MemStream and calls DbgMemRange to convert the buffer to +hexadecimal. +

- - +
- + +String with the contents read from MemStream and formatted as Hexadecimal +characters. Contains an empty string if MemStream is unassigned, not derived +from TMemoryStream, or Count is not a positive non-zero value. + - + +TCustomMemoryStream with the content converted in the routine. + - + +Number of bytes in MemStream to read and convert in the routine. + @@ -2236,12 +2294,15 @@ created. -Discards an re-creates the logger class instance got the logger type. +Discards an recreates the reference-counted logger class instance using the +logger class type for the unit. +

+RecreateDebugLogger is called from the initialization section for the +lazlogger.pas unit. +

- -
@@ -2252,7 +2313,11 @@ Discards an re-creates the logger class instance got the logger type. Unit property with the logger class instance for the logger type. - + + + + +
@@ -2270,23 +2335,44 @@ Unit property with the list of log groups defined for a logger class instance. Generates a debugger message with the content from the specified value. - + +

+DbgStr is an overloaded String function used to generate a string value using +the content and formatting specified in the parameter values. The overloaded +variants allow the string (or a range of characters in the string) which may +contain multi-byte UTF-8 characters to be formatted for use in a debugger +message. Any character with an ordinal value not in the range #32..#126 is +converted to its hexadecimal character notation like #$FF. Any character with a +value in the range #32..#126 is not altered. +

+
- + +String with the value after special characters are converted to hexadecimal +notation. + - + +String with the special characters converted to hexadecimal notation. + - + +Ordinal position for the first character examined in the routine. + - + +Pointer an Integer with the number of characters examined in the routine. + - + +Constant PChar type with the content examined and converted in the routine. + @@ -2297,10 +2383,15 @@ Generates a debugger message with the specified WideString content. - + +String with the value after special characters are converted to hexadecimal +notation. + - + +String with the special characters converted to hexadecimal notation. +