mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-14 05:41:16 +02:00
Docs: LazUtils. Updates topic formatting.
* Removes whitespace used to indent topic content. * Wraps text at 80 characters and restores EOL for wrapped lines.
This commit is contained in:
dsiders
parent
4d5df8c403
commit
f7d5147489
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -3,17 +3,17 @@
|
||||
<package name="lazutils">
|
||||
|
||||
<!--
|
||||
====================================================================
|
||||
LazLoggerDummy
|
||||
====================================================================
|
||||
====================================================================
|
||||
LazLoggerDummy
|
||||
====================================================================
|
||||
-->
|
||||
|
||||
<module name="LazLoggerDummy">
|
||||
<short>Provide an empty re-implementation of LazLoggerBase.</short>
|
||||
<descr>
|
||||
<p>
|
||||
This file is part of the <file>LazUtils</file> package.
|
||||
</p>
|
||||
<p>
|
||||
This file is part of the <file>LazUtils</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved externals -->
|
||||
@ -691,12 +691,12 @@
|
||||
</element>
|
||||
|
||||
<element name="DbgSTime">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="DbgSTime.Result">
|
||||
<short/>
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="dbgMemRange">
|
||||
@ -756,21 +756,21 @@
|
||||
</element>
|
||||
|
||||
<element name="TLazLoggerBlockHandler">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TLazLoggerBlockHandler.IncreaseIndent">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TLazLoggerBlockHandler.DecreaseIndent">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TLazLoggerLogGroupList">
|
||||
@ -1611,15 +1611,15 @@
|
||||
</element>
|
||||
|
||||
<element name="TLazLogger.DumpExceptionBackTrace">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLazLogger.DumpExceptionBackTrace.LogEnabled">
|
||||
<short/>
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TLazLogger.DumpExceptionBackTrace.LogEnabled">
|
||||
<short/>
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
|
||||
@ -3,23 +3,25 @@
|
||||
<package name="lazutils">
|
||||
|
||||
<!--
|
||||
====================================================================
|
||||
LazLoggerProfiling
|
||||
====================================================================
|
||||
====================================================================
|
||||
LazLoggerProfiling
|
||||
====================================================================
|
||||
-->
|
||||
|
||||
<module name="LazLoggerProfiling">
|
||||
<short>Contains classes and routines used for profiling in the Lazarus debugger.</short>
|
||||
<short>
|
||||
Contains classes and routines used for profiling in the Lazarus debugger.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
This file is part of the <file>LazUtils</file> package.
|
||||
</p>
|
||||
<p>
|
||||
This file is part of the <file>LazUtils</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TLazLoggerBlockTimer">
|
||||
<short>
|
||||
Provides profiler instrumentation for execution times in a logger class.
|
||||
Provides profiler instrumentation for execution times in a logger class.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -44,19 +46,22 @@
|
||||
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TLazLoggerBlockTimer.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Create sets the default value for the MaxDepth property (100), and initializes the first time value in the execution time profiler. The initial nesting level is also set (0).
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Create sets the default value for the MaxDepth property (100), and
|
||||
initializes the first time value in the execution time profiler. The initial
|
||||
nesting level is also set (0).
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLazLoggerBlockTimer.EnterBlock">
|
||||
<short>
|
||||
Captures the execution start time and nesting level when a new block is entered.
|
||||
Captures the execution start time and nesting level when a new block is
|
||||
entered.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -72,7 +77,7 @@
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLazLoggerBlockTimer.ExitBlock">
|
||||
<short>
|
||||
Updates the cumulative execution time when a block is exited.
|
||||
Updates the cumulative execution time when a block is exited.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -81,13 +86,14 @@
|
||||
<short>Logger class instance for the block handler.</short>
|
||||
</element>
|
||||
<element name="TLazLoggerBlockTimer.ExitBlock.Level">
|
||||
<short>Nesting level before the block handler is exited.</short>
|
||||
<short>Nesting level before the block handler is exited.</short>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazLoggerBlockTimer.MaxDepth">
|
||||
<short>
|
||||
Maximum depth for execution time data in the nested levels for the block handler.
|
||||
Maximum depth for execution time data in the nested levels for the block
|
||||
handler.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -96,36 +102,48 @@
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazLoggerBlockTimer.TimeDiff">
|
||||
<short>
|
||||
Calculates the cumulative execution time for the block at the specified nesting level.
|
||||
Calculates the cumulative execution time for the block at the specified
|
||||
nesting level.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
TimeDiff is a read-only QWord property which provides indexed access to the cumulative execution time for the block at the specified nesting level. The value represents a number of "ticks" or milliseconds as returned from the GetTickCount64 routine in the RTL.
|
||||
</p>
|
||||
<p>
|
||||
The property value is calculated as the difference between the current "tick" value and the execution start time from the parent block. A timer overflow condition is handled in the calculation. The property value is 0 (zero) when ALevel is not in the range 0..MaxDepth.
|
||||
</p>
|
||||
<p>
|
||||
TimeDiff is a read-only QWord property which provides indexed access to the
|
||||
cumulative execution time for the block at the specified nesting level. The
|
||||
value represents a number of "ticks" or milliseconds as returned from the
|
||||
GetTickCount64 routine in the RTL.
|
||||
</p>
|
||||
<p>
|
||||
The property value is calculated as the difference between the current "tick"
|
||||
value and the execution start time from the parent block. A timer overflow
|
||||
condition is handled in the calculation. The property value is 0 (zero) when
|
||||
ALevel is not in the range 0..MaxDepth.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TLazLoggerBlockTimer.TimeDiff.ALevel">
|
||||
<short>Nesting level for the block execution time calculated in the method.</short>
|
||||
<short>
|
||||
Nesting level for the block execution time calculated in the method.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<element name="TLazLoggerBlockTimer.Nested">
|
||||
<short>Execution time data for the block at the specified nesting level.</short>
|
||||
<short>
|
||||
Execution time data for the block at the specified nesting level.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLazLoggerBlockTimer.Nested.ALevel">
|
||||
<short>Nesting level for the calculated execution time.</short>
|
||||
<short>Nesting level for the calculated execution time.</short>
|
||||
</element>
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TLazLoggerBlockMemWatch">
|
||||
<short>
|
||||
Provides profiler instrumentation for memory allocation (heap) in a logger class.
|
||||
Provides profiler instrumentation for memory allocation (heap) in a logger
|
||||
class.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -150,16 +168,20 @@
|
||||
<element name="TLazLoggerBlockMemWatch.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Create sets the default value for the MaxDepth property (100), and initializes the first values for the memory allocation profiler. The initial nesting level is also set (0).
|
||||
</p></descr>
|
||||
<p>
|
||||
Create sets the default value for the MaxDepth property (100), and
|
||||
initializes the first values for the memory allocation profiler. The initial
|
||||
nesting level is also set (0).
|
||||
</p></descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLazLoggerBlockMemWatch.EnterBlock">
|
||||
<short>Captures memory allocation and nesting level when a block is entered.</short>
|
||||
<short>
|
||||
Captures memory allocation and nesting level when a block is entered.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -173,7 +195,8 @@
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLazLoggerBlockMemWatch.ExitBlock">
|
||||
<short>
|
||||
Updates the cumulative memory allocation for the parent block when a block is exited.
|
||||
Updates the cumulative memory allocation for the parent block when a block is
|
||||
exited.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -191,9 +214,9 @@
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazLoggerBlockMemWatch.MaxDepth">
|
||||
<short>
|
||||
Maximum depth the nested levels in the block handler.
|
||||
</short>
|
||||
<short>
|
||||
Maximum depth the nested levels in the block handler.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -202,38 +225,47 @@
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazLoggerBlockMemWatch.MemDiff">
|
||||
<short>Indicates heap memory allocation for the block at the specified nesting level.</short>
|
||||
<short>
|
||||
Indicates heap memory allocation for the block at the specified nesting level.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
MemDiff is a read-only Int64 property which provides indexed access to the cumulative memory usage for a block at a specified nesting level. The value is calculated as the difference between the current memory allocation in the block and the initial memory allocation in the parent block. The property value reflects heap memory allocation.
|
||||
</p>
|
||||
<p>
|
||||
The property value is 0 (zero) if ALevel is not in the range 0..MaxDepth.
|
||||
</p>
|
||||
<p>
|
||||
MemDiff is a read-only Int64 property which provides indexed access to the
|
||||
cumulative memory usage for a block at a specified nesting level. The value
|
||||
is calculated as the difference between the current memory allocation in the
|
||||
block and the initial memory allocation in the parent block. The property
|
||||
value reflects heap memory allocation.
|
||||
</p>
|
||||
<p>
|
||||
The property value is 0 (zero) if ALevel is not in the range 0..MaxDepth.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TLazLoggerBlockMemWatch.MemDiff.ALevel">
|
||||
<short>Nesting level for the block reflected in the property value.</short>
|
||||
<short>Nesting level for the block reflected in the property value.</short>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazLoggerBlockMemWatch.Nested">
|
||||
<short>Memory allocation data for the block at the specified nesting level.</short>
|
||||
<short>
|
||||
Memory allocation data for the block at the specified nesting level.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TLazLoggerBlockMemWatch.Nested.ALevel">
|
||||
<short>Nesting level for the block reflected in the property value.</short>
|
||||
<short>Nesting level for the block reflected in the property value.</short>
|
||||
</element>
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="DbgsMemUsed">
|
||||
<short>
|
||||
Generates a formatted message with memory usage for the parent, current, or child block(s).
|
||||
Generates a formatted message with memory usage for the parent, current, or
|
||||
child block(s).
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -254,9 +286,10 @@
|
||||
|
||||
<!-- function Visibility: default -->
|
||||
<element name="DbgsTimeUsed">
|
||||
<short>
|
||||
Generates a formatted message with execution times for the parent, current, or child blocks.
|
||||
</short>
|
||||
<short>
|
||||
Generates a formatted message with execution times for the parent, current,
|
||||
or child blocks.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
@ -277,7 +310,8 @@
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="DbgStartTimer">
|
||||
<short>
|
||||
Gets or creates timing data for the specified name, and updates its last execution time.
|
||||
Gets or creates timing data for the specified name, and updates its last
|
||||
execution time.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -293,7 +327,8 @@
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="DbgStopTimer">
|
||||
<short>
|
||||
Updates timing data using the specified name when it is stopped, and calculates its cumulative execution time.
|
||||
Updates timing data using the specified name when it is stopped, and
|
||||
calculates its cumulative execution time.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -308,9 +343,10 @@
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="DbgStartMemWatch">
|
||||
<short>
|
||||
Gets or creates memory allocation data for the specified name, and initializes its data.
|
||||
</short>
|
||||
<short>
|
||||
Gets or creates memory allocation data for the specified name, and
|
||||
initializes its data.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
@ -319,14 +355,15 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="DbgStartMemWatch.AName">
|
||||
<short>Name for the memory allocation data updated in the routine.</short>
|
||||
<short>Name for the memory allocation data updated in the routine.</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="DbgStopMemWatch">
|
||||
<short>
|
||||
Updates memory allocation data using the specified name when it is stopped, and calculates its cumulative usage.
|
||||
</short>
|
||||
<short>
|
||||
Updates memory allocation data using the specified name when it is stopped,
|
||||
and calculates its cumulative usage.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
@ -335,7 +372,9 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="DbgStopMemWatch.AName">
|
||||
<short>Name for the associated memory allocation data updated in the routine.</short>
|
||||
<short>
|
||||
Name for the associated memory allocation data updated in the routine.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
</module> <!-- LazLoggerProfiling -->
|
||||
|
||||
Loading…
Reference in New Issue
Block a user