From 94bd8f9aae3a9155b88686a59d103b4a2c47fd68 Mon Sep 17 00:00:00 2001
From: dsiders <dsiders@lazarus-ide.org>
Date: Sat, 16 Nov 2024 01:59:01 +0000
Subject: [PATCH] Docs: LCL/intfgraphics. Adds the
 TLazReaderBMP.InternalReadHead topic for changes in a153126d5a. Issue #40685.

(cherry picked from commit 1bcd35277396bf5199d227fa8ca30d578ed14008)
---
 docs/xml/lcl/intfgraphics.xml | 40 +++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

diff --git a/docs/xml/lcl/intfgraphics.xml b/docs/xml/lcl/intfgraphics.xml
index 6265b99496..f58afdc7c8 100644
--- a/docs/xml/lcl/intfgraphics.xml
+++ b/docs/xml/lcl/intfgraphics.xml
@@ -28,6 +28,8 @@ Author: Mattias Gaertner
 </p>
 </descr>
 
+<!-- TODO: Most topics in this module need content. -->
+
 <element name="Classes"/>
 <element name="SysUtils"/>
 <element name="Math"/>
@@ -2956,6 +2958,44 @@ Some bitmaps can specify the data offset.
 <seealso/>
 </element>
 
+<element name="TLazReaderBMP.InternalReadHead">
+<short>
+Performs actions needed to read the header for the bitmap and return the width 
+and height as a TPoint value.
+</short>
+<descr>
+<p>
+<var>InternalReadHead</var> is an overridden <var>TPoint</var> class function. 
+The return value contains the width and height for the bitmap read from the 
+header. The X member contains the width for the bitmap. The Y member contains 
+the height for the bitmap. The return value is an empty TPoint instance (X=0, 
+Y=0) if the bitmap file header does not contain the bitmap magic word "BM" in 
+the header type.
+</p>
+<p>
+InternalReadHead is conditionally defined for FPC compiler versions prior to 
+3.3.1 where the InternalSize function was not implemented in an ancestor class 
+to use values in the bitmap header.
+</p>
+</descr>
+<version>
+Added in LCL version 4.0. It is conditionally defined for FPC compiler versions 
+prior to 3.3.1 <b>only</b>.
+</version>
+<seealso/>
+</element>
+<element name="TLazReaderBMP.InternalReadHead.Result">
+<short>
+TPoint instance with the width and height read from the bitmap header, or an 
+empty point when dimensions are not found in the header.
+</short>
+</element>
+<element name="TLazReaderBMP.InternalReadHead.Stream">
+<short>
+TStream instance with the bitmap resources examined in the method.
+</short>
+</element>
+
 <element name="TLazWriterBMP">
 <short/>
 <descr/>