View Issue Details

IDProjectCategoryView StatusLast Update
0035054LazarusDocumentationpublic2019-10-13 09:52
ReporterDon Siders Assigned ToMattias Gaertner  
PrioritynormalSeverityminorReproducibilityN/A
Status closedResolutionfixed 
PlatformanyOSany 
Product Version2.1 (SVN) 
Summary0035054: Fixed errors in documentation for lazutils/lazutf8classes.xml
Description* removed invalid remarks tag; replaced with remark tag
* fixed spelling and grammar errors
* used lt, gt character entities for %lt;%gt;

SVN diff file attached.
TagsNo tags attached.
Fixed in Revision60397.
LazTarget-
Widgetset
Attached Files

Relationships

related to 0036167 closedJuha Manninen Updated documentation in LazFileUtils.xml 

Activities

Don Siders

2019-02-10 08:29

reporter  

lazutf8classes.xml.diff (2,377 bytes)   
Index: lazutf8classes.xml
===================================================================
--- lazutf8classes.xml	(revision 60339)
+++ lazutf8classes.xml	(working copy)
@@ -11,9 +11,9 @@
         <p>
           lazutf8classes implements UTF-8-enabled classes and routines, including: TFileStreamUTF8, TMemoryStreamUTF8, and TStringListUTF8.
         </p>
-        <remarks>
+        <remark>
           lazutf8classes has an implementation dependency on the lazfileutils unit.
-        </remarks>
+        </remark>
       </descr>
 
       <!-- class Visibility: default -->
@@ -76,14 +76,14 @@
             Please note that sharing is advisory on Unix-like platforms.
           </p>
           <p>
-            Rights is the file rights for the specified file. The default value is 438 (Decimal) or &666 (Octal) and indicates that the owner,  group, and others  can read and/or write to the file. The value in Rights is ignored on the Windows platform.
+            Rights is the file rights for the specified file. The default value is 438 (Decimal) or 666 (Octal) and indicates that the owner,  group, and others  can read and/or write to the file. The value in Rights is ignored on the Windows platform.
           </p>
           <p>
             Create  instantiates a THandleStream (owned by the current class instance) which uses the valid file handle.
           </p>
-          <remarks>
+          <remark>
             Please note that Create can raise an exception if the file handle from FileCreateUTF8 or FileOpenUTF8 is invalid (contains feInvalidHandle).
-          </remarks>
+          </remark>
         </descr>
         <errors>
           <dl>
@@ -311,11 +311,11 @@
             CompareStringListItemsUTF8LowerCase converts the string values to lowercase using UTF8LowerCase, and calls the CompareStr function to perform the comparison. The return vaue is in the following ranges:
           </p>
           <dl>
-            <dt><code> <0 </code></dt>
+            <dt><code> &lt;0 </code></dt>
             <dd>String at Index1 comes before String at Index2</dd>
             <dt><code> 0 </code></dt>
             <dd>Strings have the same value</dd>
-            <dt><code> >0 </code> </dt>
+            <dt><code> &gt;0 </code> </dt>
             <dd>String at Index1 comes after String at Index2</dd>
           </dl>
         </descr>
lazutf8classes.xml.diff (2,377 bytes)   

Issue History

Date Modified Username Field Change
2019-02-10 08:29 Don Siders New Issue
2019-02-10 08:29 Don Siders File Added: lazutf8classes.xml.diff
2019-02-10 09:23 Mattias Gaertner Assigned To => Mattias Gaertner
2019-02-10 09:23 Mattias Gaertner Status new => assigned
2019-02-10 09:29 Mattias Gaertner Fixed in Revision => 60397.
2019-02-10 09:29 Mattias Gaertner LazTarget => -
2019-02-10 09:29 Mattias Gaertner Status assigned => resolved
2019-02-10 09:29 Mattias Gaertner Resolution open => fixed
2019-02-10 16:53 Don Siders Status resolved => closed
2019-10-13 09:52 Juha Manninen Relationship added related to 0036167