Docs: Removes redundant text in remark tags.

This commit is contained in:
dsiders 2022-03-02 01:43:48 +00:00
parent 3bbe97775f
commit 891501a228
14 changed files with 58 additions and 46 deletions

View File

@ -785,7 +785,7 @@
Create configures the <var>Edit</var> and <var>UpDown</var> instances used in the grouped edit control. Edit is configured to use right alignment for its text (since it is a numeric value). UpDown is configured to include the flags needed in its ControlStyle property. The OnChangingEx and OnClick event handlers for UpDown are also set in the method.
</p>
<remark>
Please note: UpDown does not use its Associate property to maintain the relationship to Edit. This is by design, and allows Edit to be used with floating point numbers and have a NullValue (in a descendent class instance). It also enables proper alignment and anchoring for the grouped edit control.
UpDown does not use its Associate property to maintain the relationship to Edit. This is by design, and allows Edit to be used with floating point numbers and have a NullValue (in a descendent class instance). It also enables proper alignment and anchoring for the grouped edit control.
</remark>
<p>
Internal members needed in the class instance are also initialized.
@ -813,7 +813,7 @@
The return value contains the original value after it has been range adjusted. When AValue is smaller than MinValue, MinValue is assigned to the return value. When AValue is larger than MaxValue, MaxValue is assigned to the return value.
</p>
<remark>
Please note: The return value is not range adjusted when MinValue and MaxValue have the same value. This is Delphi VCL compatible.
The return value is not range adjusted when MinValue and MaxValue have the same value. This is Delphi VCL compatible.
</remark>
</descr>
<seealso/>

View File

@ -89,7 +89,7 @@
<short>Load the TrueType header table in the resident table.</short>
<descr>
<remark>
Please note: A font header is a static table that owns no subttable. It has neither a constructor nor a destructor.
A font header is a static table that owns no subttable. It has neither a constructor nor a destructor.
</remark>
</descr>
<seealso/>
@ -105,7 +105,7 @@
<short>Loads the location table in resident table.</short>
<descr>
<remark>
Please note: The Font Header <b>must</b> be loaded in the leading segment before calling this function. This table is destroyed directly by the resident destructor.
The Font Header <b>must</b> be loaded in the leading segment before calling this function. This table is destroyed directly by the resident destructor.
</remark>
</descr>
<seealso/>
@ -137,7 +137,7 @@
<short/>
<descr>
<remark>
Please note: The Cmap table directory is destroyed by the resident destructor. The Cmap subtables must be destroyed by Free_CMap_Table.
The Cmap table directory is destroyed by the resident destructor. The Cmap subtables must be destroyed by Free_CMap_Table.
</remark>
</descr>
<seealso/>
@ -165,7 +165,7 @@
<short>Loads the name table into the face table.</short>
<descr>
<remark>
Please note: This attribute table is destroyed by the resident destructor.
This attribute table is destroyed by the resident destructor.
</remark>
</descr>
<seealso/>

View File

@ -37,7 +37,7 @@
<li>added variable precision for finer rendering at small ppems</li>
</ul>
<remark>
Please note: The interface in the unit may change in the future.
The interface in the unit may change in the future.
</remark>
</descr>

View File

@ -212,7 +212,7 @@
PushInternal calls <var>System.Move</var> to transfer byte data from Source to the internal storage for the queue, or calls the Read method in AStream to read the item data. The <var>Size</var> property is incremented by the number of bytes actually read in the method. <var>AddItem</var> is called to adjust the internal storage allocation for the calculated item size.
</p>
<remark>
Please note: PushInternal assumes that the TStream instance is already positioned at the location needed to access the item data for the queue entry. It does not reposition the stream prior to or following a call to the TStream.Read method. Be aware that reading from a stream can raise an exception.
PushInternal assumes that the TStream instance is already positioned at the location needed to access the item data for the queue entry. It does not reposition the stream prior to or following a call to the TStream.Read method. Be aware that reading from a stream can raise an exception.
</remark>
<p>
The return value contains the number of bytes transferred to the internal queue storage in the method.
@ -368,7 +368,7 @@
<var>Push</var> is an overloaded <var>Integer</var> function used to add the specified item data to the bottom of the FIFO queue. Overloaded variants are provided to supply item data as a sequence of arbitrary byte values, either from an untyped buffer or from a <var>TStream</var> instance.
</p>
<remark>
Please note: Push assumes that <var>AStream</var> is already positioned at the start of the data for the new item. It does not reposition the stream instance.
Push assumes that <var>AStream</var> is already positioned at the start of the data for the new item. It does not reposition the stream instance.
</remark>
<p>
Push calls the <var>PushInternal</var> method to perform the actions needed to enqueue the specified item data.
@ -407,7 +407,7 @@
<var>Pop</var> is an overloaded <var>Integer</var> function used to remove an item from the top of the FIFO queue. Overloaded variants are provided to get item data and store them as a sequence of arbitrary byte values, either in an untyped buffer or in a <var>TStream</var> instance.
</p>
<remark>
Please note: Pop assumes that <var>AStream</var> is already positioned where the item data will be written. It does not reposition the stream instance. Be aware that writing to a stream can raise an exception.
Pop assumes that <var>AStream</var> is already positioned where the item data will be written. It does not reposition the stream instance. Be aware that writing to a stream can raise an exception.
</remark>
<p>
Pop calls the <var>PopTopInternal</var> method to perform the actions needed to get the data for the queue item, and to removed the entry from the top of FIFO queue.

View File

@ -397,7 +397,7 @@
<var>InternalCleanNode</var> ensures that the specified DOM node is removed from the <var>Document</var>, both as a parent or child node in the element tree. InternalCleanNode calls <var>InvalidatePathCache</var> to reflect the change in the Document, and sets the value in <var>Modified</var> to <b>True</b>.
</p>
<remark>
Please note: No actions are performed in the method when Node is unassigned (contains <b>Nil</b>).
No actions are performed in the method when Node is unassigned (contains <b>Nil</b>).
</remark>
<p>
InternalCleanNode is used in the implementation of the <var>DeletePath</var> and <var>DeleteValue</var> methods.
@ -755,7 +755,7 @@
<var>DeletePath</var> calls <var>InternalFindNode</var> to get the node removed in the method. The node is removed from its parent DOM node, and the value in <var>Modified</var> is set to <b>True</b>. The <var>InvalidatePathCache</var> method is called to reflect the change in the Document. <var>InternalCleanNode</var> is called to ensure that the node is removed from the parent DOM node in <var>Document</var>.
</p>
<remark>
Please note: No actions are performed in the method when a node for the specified path cannot be located, or the node does not have a parent node (it is the root node in the Document).
No actions are performed in the method when a node for the specified path cannot be located, or the node does not have a parent node (it is the root node in the Document).
</remark>
</descr>
<seealso>
@ -780,7 +780,7 @@
DeleteValue calls the <var>FindNode</var> method to get the DOM node updated in the method.
</p>
<remark>
Please note: No actions are performed in the method when a node cannot be found with the specified path.
No actions are performed in the method when a node cannot be found with the specified path.
</remark>
</descr>
<seealso>
@ -1020,7 +1020,7 @@
If <var>Document</var> contains a valid <var>TXMLDocument</var> instance, the <var>Flush</var> method is called to write any pending changes to disk. The <var>FreeDoc</var> method is called to re-initialize the <var>Document</var> instance. The XML content in <var>Document</var> is then reloaded using the file or string content as required.
</p>
<remark>
Please note: No actions are performed in the method when the value in <var>Filename</var> is assigned as the component is loaded using the LCL streaming mechanism.
No actions are performed in the method when the value in <var>Filename</var> is assigned as the component is loaded using the LCL streaming mechanism.
</remark>
</descr>
<seealso>
@ -1121,7 +1121,7 @@
<li>tkClass</li>
</ul>
<remark>
Please note: Properties must be implemented with both getter and setter procedures to be available for use in <var>TRttiXMLConfig</var>. Properties which do not use both types of procedure are ignored.
Properties must be implemented with both getter and setter procedures to be available for use in <var>TRttiXMLConfig</var>. Properties which do not use both types of procedure are ignored.
</remark>
</descr>
<seealso>

View File

@ -311,7 +311,7 @@
The return value is True when a file can be added, deleted, or modified in the specified path. To get the return value, DirectoryIsWritable creates a temporary file in DirectoryName, adds content to it, and deletes the temporary file. DirectoryIsWritable calls the FileCreateUTF8, FileWrite, FileClose, and DeleteFileUTF8 routines to perform the file operations. The return value is True when FileWrite completes successfully.
</p>
<remark>
Please note: DirectoryIsWritable calls InvalidateFileStateCache with the temporary file name if DeleteFileUTF8 cannot remove the file.
DirectoryIsWritable calls InvalidateFileStateCache with the temporary file name if DeleteFileUTF8 cannot remove the file.
</remark>
</descr>
<errors>
@ -1053,7 +1053,7 @@ D:\db\employee.fdb
PathIsInPath calls the <var>CompareFilenames</var> routine to determine the return value for the function.
</p>
<remark>
Please note: PathIsInPath ensures that a trailing path delimiter is included in the Path and Directory arguments prior to performing its comparison. On Windows, this results in a Path like 'C:' being treated as if it contains 'C:\'.
PathIsInPath ensures that a trailing path delimiter is included in the Path and Directory arguments prior to performing its comparison. On Windows, this results in a Path like 'C:' being treated as if it contains 'C:\'.
</remark>
</descr>
<seealso/>
@ -1077,7 +1077,7 @@ D:\db\employee.fdb
<var>ShortDisplayFilename</var> is a <var>String</var> function used to get a shortened version of the specified file name up to the specified maximum length. The characters '...' are appended to a shortened file name.
</p>
<remark>
Please note: These are three (3) Period characters and not an Ellipsis character.
These are three (3) Period characters and not an Ellipsis character.
</remark>
<p>
The return value is the same as the <var>aFileName</var> argument if the file name did not need to be shortened.

View File

@ -15,7 +15,7 @@
<file>lazlistclasses.pas</file> contains list classes implemented using generics. The lists are provided as "object" and "class" versions. Each list can be specialized to hold either items of a given type (specialized to type at compile-time) or untyped data with the size specified as a run-time argument to the constructor.
</p>
<remark>
Please note: The current implementations for these list classess are not suitable for managed types, such as String.
The current implementations for these list classes are not suitable for managed types, such as String.
</remark>
<p>
<b>TLazShiftBufferList</b>

View File

@ -72,7 +72,7 @@
<var>RaiseGDBException</var> is a procedure used to raise an exception in the GDB debugger. Normally, GDB does not catch FPC <var>Exception</var> objects. This procedure raises a standard <b>"Division By Zero"</b> exception, which <b>IS</b> caught by GDB. This allows a program to be stopped in the debugger without extra GDB configuration.
</p>
<remark>
Please note: For the Amiga platform, Division by Zero errors are not catchable. The program will simply crash.
For the Amiga platform, Division by Zero errors are not catchable. The program will simply crash.
</remark>
<p>
<var>Msg</var> contains the value used as the message in the exception.
@ -91,7 +91,7 @@
<var>RaiseAndCatchException</var> is a procedure used to generate an <var>Exception</var> that is caught and handled by an application.
</p>
<remark>
Please note: For the Amiga platform, Division by Zero errors are not catchable. The program will simply crash.
For the Amiga platform, Division by Zero errors are not catchable. The program will simply crash.
</remark>
</descr>
<seealso></seealso>

View File

@ -323,7 +323,7 @@
Create sets values in the Name, Kind, AutoSize, TabOrder, Align, and Default properties in the button instance. The Bitmap for the button Glyph is created or re-assigned as necessary.
</p>
<remark>
Please note: No actions are performed in the method if the button type in AButton has already been created for the panel.
No actions are performed in the method if the button type in AButton has already been created for the panel.
</remark>
<p>
CreateButton is used in the implementation of the DoShowButtons method.
@ -367,7 +367,7 @@
<var>DoShowButtons</var> calls <var>UpdateButtonOrder</var> to display the buttons in the order specified in the <var>ButtonOrder</var> property. <var>UpdateButtonLayout</var> is called to ensure that the buttons use custom alignment, and to set the default button for the layout.
</p>
<remark>
Please note: <var>Autosizing</var> for the panel control is disabled prior to updating the button layout, and restored prior to exiting from the method.
<var>Autosizing</var> for the panel control is disabled prior to updating the button layout, and restored prior to exiting from the method.
</remark>
<p>
<var>DoShowButtons</var> is called when a value is assigned to the <var>ShowButtons</var> property.
@ -388,7 +388,7 @@
<var>DoShowGlyphs</var> is a procedure used to assign the bitmaps used as glyphs for the buttons on the panel. DoShowGlyphs iterates over the buttons displayed on the panel, and uses the values in the <var>ShowGlyphs</var> property to set or reset the glyph used in the button instance.
</p>
<remark>
Please note: <var>Autosizing</var> for the panel control is disabled prior to updating the button glyphs, and restored prior to exiting from the method.
<var>Autosizing</var> for the panel control is disabled prior to updating the button glyphs, and restored prior to exiting from the method.
</remark>
<p>
<var>DoShowGlyph</var> is called when a value is assigned to the <var>ShowGlyphs</var> property.
@ -573,7 +573,7 @@
<var>UpdateSizes</var> is called when a value is assigned to the <var>Align</var> property, and from the <var>Notification</var> method.
</p>
<remark>
Please note: No actions are performed in the method at design-time.
No actions are performed in the method at design-time.
</remark>
</descr>
<seealso>

View File

@ -417,7 +417,7 @@
<dd>Uses the value from SystemShowButtonGlyphs as the return value</dd>
</dl>
<remark>
Please note: The return value is always True at design-time.
The return value is always <b>True</b> at design-time.
</remark>
<p>
Use CanShowGlyph to determine if an image is available to be drawn on the button.

View File

@ -1949,7 +1949,7 @@
<var>BeginDrag</var> is a <var>Boolean</var> function used to start display of images in the resolution for a Drag and Drop operation. The return value is <b>True</b> if the widgetset successfully received the BeginDrag notification.
</p>
<remark>
Please note: No actions are performed in the method if the widgetset class does note successfully start the drag operation.
No actions are performed in the method if the widgetset class does note successfully start the drag operation.
</remark>
<p>
BeginDrag calls the <var>DragLock</var> method to lock the window handle for the control, and to start displaying the drag image for the operation. The current screen cursor is captured, and the <var>DragCursor</var> in <var>ImageList</var> is displayed for the operation.
@ -7963,7 +7963,7 @@
In the floating state, it sets UndockWidth/Height to the current Width/Height. In docked state, it sets LRDockWidth/TBDockHeight to the current Width/Height.
</p>
<remark>
Please note: Should save both in any case, independent from DockOrientation or host Align. Rationale: a DockManager will either ignore these values, or use them according to the <b><i>new</i></b> alignment. Without a DockManager both extents are required, because no (valid) alignment information applies.
Should save both in any case, independent from DockOrientation or host Align. Rationale: a DockManager will either ignore these values, or use them according to the <b><i>new</i></b> alignment. Without a DockManager both extents are required, because no (valid) alignment information applies.
</remark>
</descr>
</element>
@ -8225,7 +8225,7 @@
When an OnDragOver handler is installed, Accept is set to <b>True</b> and can be changed by the handler.
</p>
<remark>
Please note: Source can be either a TDragObject, or the dragged control.
Source can be either a TDragObject, or the dragged control.
</remark>
</descr>
<seealso>

View File

@ -229,7 +229,8 @@
<b>Nil</b> when the FieldName does not exist in the linked dataset. If the Field is assigned (not
<b>Nil</b>), the EditingChanged and RecordChanged methods are called.
</p>
<remark>Please note: LayoutChanged does not call the inherited method.
<remark>
LayoutChanged does not call the inherited method.
</remark>
<p>LayoutChanged is used primarily in the implementation of methods in TCustomDBGrid and descendent classes.
</p>
@ -280,7 +281,8 @@
</p>
<p>UpdateData signals the <var>OnUpdateData</var> event handler when it has been assigned for the class instance. This event handler normally contains a reference to the <var>UpdateData</var> method defined for the associated data-aware <var>Control</var>, such as <var>TCustomDBGrid.UpdateData</var> and <var>TDBEdit.UpdateData</var>.
</p>
<remark>Please note: UpdateData does <b>not</b> call the inherited method in the ancestor class.
<remark>
UpdateData does <b>not</b> call the inherited method in the ancestor class.
</remark>
</descr>
<seealso>
@ -1181,7 +1183,8 @@
<var>CanModify</var> property in the
<var>TFieldDataLink</var> instance in the control.
</p>
<remark>Please note: EditCanModify does <b>NOT</b> call the inherited method which always returns <b>True</b>. In addition, it is provided to maintain Delphi code compatibility; it is not referenced directly by any methods in the implementation of the control or its descendants.
<remark>
EditCanModify does <b>NOT</b> call the inherited method which always returns <b>True</b>. In addition, it is provided to maintain Delphi code compatibility; it is not referenced directly by any methods in the implementation of the control or its descendants.
</remark>
</descr>
<seealso>
@ -1464,7 +1467,8 @@
</p>
<p>Read and write access for the property value are redirected to the ReadOnly property in the TFieldDataLink instance used in the control.
</p>
<remark>Please note: A value assigned to ReadOnly may be overridden by the Field definition from the target database table.
<remark>
A value assigned to ReadOnly may be overridden by the Field definition from the target database table.
</remark>
</descr>
<seealso>
@ -2765,7 +2769,8 @@
<var>TDBLookupListBox</var>. It implements the abstract virtual method defined in the ancestor class. UpdateData uses the value in
<var>ItemIndex</var> to update the internal TDBLookup instance for the control. When ItemIndex contains a positive non-zero value, the UpdateData method in TDBLookup is called to apply the ItemIndex value.
</p>
<remark>Please note: No actions are performed in the method when ItemIndex contains a negative non-zero value.
<remark>
No actions are performed in the method when ItemIndex contains a negative non-zero value.
</remark>
<p>UpdateData is called from the <var>DoSelectionChange</var> method when <var>IsUnbound</var> returns <b>True</b>.
</p>
@ -4301,7 +4306,8 @@
<var>Change</var> is an overridden method in
<var>TCustomDBComboBox</var>. It ensures that the internal data link for the control is notified when the value for the control is changed. This includes posting the DBCBEVENT_CHANGE deferred event message to the handle for the control.
</p>
<remark>Please note: Change does not call the inherited method directly.
<remark>
Change does not call the inherited method directly.
</remark>
</descr>
<seealso>
@ -4571,7 +4577,8 @@
</p>
<p>Read and write access for the property value are redirected to the ReadOnly property in the TFieldDataLink instance used in the control.
</p>
<remark>Please note: A value assigned to ReadOnly may be overridden by the Field definition from the target database table.
<remark>
A value assigned to ReadOnly may be overridden by the Field definition from the target database table.
</remark>
</descr>
<seealso>
@ -6845,7 +6852,8 @@
<descr>
<p>QuickDraw is a Boolean property which indicates if QuickDraw is enabled for the platform or OS. The default value for the property is <b>True</b>.
</p>
<remark>Please note: QucikDraw is not used in the current LCL implementation.
<remark>
QucikDraw is not used in the current LCL implementation.
</remark>
</descr>
<seealso/>
@ -7255,7 +7263,8 @@
</p>
<p>Read and write access for the property value are redirected to the ReadOnly property in the TFieldDataLink instance used in the control.
</p>
<remark>Please note: A value assigned to ReadOnly may be overridden by the Field definition from the target database table.
<remark>
A value assigned to ReadOnly may be overridden by the Field definition from the target database table.
</remark>
</descr>
<seealso>
@ -7365,7 +7374,8 @@
<var>NavStyle</var> property in
<var>TDBNavButton</var>.
</p>
<remark>Please note: These style options are not used in the current implementation of the LCL.
<remark>
These style options are not used in the current implementation of the LCL.
</remark>
</descr>
<seealso>
@ -8000,7 +8010,8 @@
<var>TDBCustomNavigator</var> control is called when the value in
<var>DataSet</var> has been changed.
</p>
<remark>Please note: ActiveChanged does not call the inherited method.
<remark>
ActiveChanged does not call the inherited method.
</remark>
</descr>
<seealso/>
@ -8016,7 +8027,8 @@
<var>TDBNavDataLink</var> used to ensure that the Navigator control is updated when the value for the
<var>Active</var> property has been changed.
</p>
<remark>Please note: ActiveChanged does not call the inherited method.
<remark>
ActiveChanged does not call the inherited method.
</remark>
</descr>
<seealso>

View File

@ -1957,7 +1957,7 @@
<var>Destroy</var> is the overridden destructor for the class instance. Destroy calls the inherited destructor.
</p>
<remark>
Please note: Resources allocated for BaseEditor and Buddy in the constructor are not explicitly freed in the destructor; that action is performed using the Notification that occurs when this class instance (which is the owner for those resources) is freed.
Resources allocated for BaseEditor and Buddy in the constructor are not explicitly freed in the destructor; that action is performed using the Notification that occurs when this class instance (which is the owner for those resources) is freed.
</remark>
</descr>
<seealso/>
@ -2133,7 +2133,7 @@
Read and write access to the property value are redirected to the <var>BaseEditor</var> control.
</p>
<remark>
Please note: The value in CharCase can automatically be changed to ecNormal when an edit mask is assigned to the control.
The value in CharCase can automatically be changed to ecNormal when an edit mask is assigned to the control.
</remark>
</descr>
<seealso>

View File

@ -2334,7 +2334,7 @@
<element name="TCustomImageList.GetResolutionCount">
<short>Gets the value for the ResolutionCount property.</short>
<seealso>
<link id="TCustomImageList.ResolutionCount"/>
<link id="TCustomImageList.ResolutionCount"/>
</seealso>
<seealso>
<link id="TCustomImageList.ResolutionCount"/>
@ -2659,7 +2659,7 @@
Create calls the <var>Initialize</var> method to allocate resources and to set the default value for properties used in the image list.
</p>
<remark>
Please note: CreateSize does not assign a value for the Owner property; it will not receive Notify events when the Application, Form, or Component where it is used is freed.
CreateSize does not assign a value for the Owner property; it will not receive Notify events when the Application, Form, or Component where it is used is freed.
</remark>
</descr>
<seealso>
@ -2834,7 +2834,7 @@
<var>WriteData</var> is a procedure used to write the image data for the default resolution to the stream specified in AStream. WriteData calls <var>GetResolution</var> using the value in <var>Width</var> to retrieve the default image resolution. The WriteData method in <var>TCustomImageListResolution</var> is called to perform the write operation using the specified stream.
</p>
<remark>
Please note: Data compression is enabled when writing image data for the resolution. Data compression was not enabled in previous LCL versions to maintain compatibility with earlier versions of Lazarus. That backward compatibility is no longer possible with image compression enabled.
Data compression is enabled when writing image data for the resolution. Data compression was not enabled in previous LCL versions to maintain compatibility with earlier versions of Lazarus. That backward compatibility is no longer possible with image compression enabled.
</remark>
<p>
Use <var>WriteAdvData</var> to write image data for all resolutions in the image list.