docs: clean up, issue #35288

git-svn-id: trunk@60786 -
This commit is contained in:
mattias 2019-03-27 09:11:41 +00:00
parent 3c24b3ee10
commit e36ca85ceb
4 changed files with 1 additions and 809 deletions

4
.gitattributes vendored
View File

@ -6059,6 +6059,7 @@ docs/xml/lazutils/extendedstrings.xml svneol=native#text/plain
docs/xml/lazutils/fileutil.xml svneol=native#text/plain
docs/xml/lazutils/fpcadds.xml svneol=LF#text/xml eol=lf
docs/xml/lazutils/fpmake.xml svneol=native#text/plain
docs/xml/lazutils/graphtype.xml svneol=LF#text/xml eol=lf
docs/xml/lazutils/html2textrender.xml svneol=native#text/plain
docs/xml/lazutils/laz2_dom.xml svneol=native#text/plain
docs/xml/lazutils/laz2_xmlcfg.xml svneol=native#text/plain
@ -6171,7 +6172,6 @@ docs/xml/lcl/forms/tapplication_queueasynccall.pas svneol=native#text/plain
docs/xml/lcl/fpmake.xml svneol=native#text/plain
docs/xml/lcl/graphics.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/graphmath.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/graphtype.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/graphutil.xml svneol=native#text/plain
docs/xml/lcl/grids.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/groupededit.xml svneol=native#text/plain
@ -6218,7 +6218,6 @@ docs/xml/lcl/interfaces/win32/win32int.xml svneol=native#text/xml
docs/xml/lcl/intfgraphics.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/jsonpropstorage.xml svneol=native#text/plain
docs/xml/lcl/lazcanvas.xml svneol=native#text/plain
docs/xml/lcl/lazconfigstorage.xml svneol=native#text/plain
docs/xml/lcl/lazdeviceapis.xml svneol=native#text/plain
docs/xml/lcl/lazdialogs.xml svneol=native#text/plain
docs/xml/lcl/lazfreetypeintfdrawer.xml svneol=native#text/plain
@ -6240,7 +6239,6 @@ docs/xml/lcl/lcltranslator.xml svneol=native#text/plain
docs/xml/lcl/lcltype.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/lclunicodedata.xml svneol=native#text/plain
docs/xml/lcl/lclversion.xml svneol=native#text/plain
docs/xml/lcl/lconvencoding.xml svneol=LF#text/plain eol=lf
docs/xml/lcl/ldocktree.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/lmessages.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/lresources.xml svneol=LF#text/xml eol=lf

View File

@ -1,691 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
LazConfigStorage
====================================================================
-->
<module name="LazConfigStorage">
<short/>
<descr>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TConfigStorage">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TConfigStorage.FPathStack">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TConfigStorage.FCurrentBasePath">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- function Visibility: protected -->
<element name="TConfigStorage.GetFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.ADefault">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TConfigStorage.GetFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.ADefault">
<short/>
</element>
<!-- function Visibility: protected -->
<element name="TConfigStorage.GetFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetFullPathValue.ADefault">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TConfigStorage.SetFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetFullPathValue.AValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TConfigStorage.SetDeleteFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.AValue">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.DefValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TConfigStorage.SetFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetFullPathValue.AValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TConfigStorage.SetDeleteFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.AValue">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.DefValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TConfigStorage.SetFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetFullPathValue.AValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TConfigStorage.SetDeleteFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.AValue">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteFullPathValue.DefValue">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TConfigStorage.DeleteFullPath">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.DeleteFullPath.APath">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TConfigStorage.DeleteFullPathValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.DeleteFullPathValue.APath">
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TConfigStorage.Create">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.Create.Filename">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.Create.LoadFromDisk">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TConfigStorage.Destroy">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TConfigStorage.GetValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TConfigStorage.GetValue.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetValue.ADefault">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TConfigStorage.GetValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TConfigStorage.GetValue.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetValue.ADefault">
<short/>
</element>
<!-- function Visibility: public -->
<element name="TConfigStorage.GetValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TConfigStorage.GetValue.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.GetValue.ADefault">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.SetValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetValue.AValue">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.SetDeleteValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.AValue">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.DefValue">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.SetValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetValue.AValue">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.SetDeleteValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.AValue">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.DefValue">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.SetValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetValue.AValue">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.SetDeleteValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.APath">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.AValue">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.SetDeleteValue.DefValue">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.DeletePath">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.DeletePath.APath">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.DeleteValue">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.DeleteValue.APath">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TConfigStorage.CurrentBasePath">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TConfigStorage.ExtendPath">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TConfigStorage.ExtendPath.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.ExtendPath.APath">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.AppendBasePath">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TConfigStorage.AppendBasePath.Path">
<short/>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.UndoAppendBasePath">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TConfigStorage.WriteToDisk">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function Visibility: public -->
<element name="TConfigStorage.GetFilename">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="TConfigStorage.GetFilename.Result">
<short/>
</element>
<!-- "class of" type Visibility: default -->
<element name="TConfigStorageClass">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- LazConfigStorage -->
</package>
</fpdoc-descriptions>

View File

@ -1,115 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
LConv
====================================================================
-->
<module name="LConvEnconding">
<short>Contains routines and tables to convert text between various encodings.</short>
<descr/>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
<short/>
<descr/>
<seealso/>
</element>
<!-- unresolved type reference Visibility: default -->
<element name="classes">
<short/>
<descr/>
<seealso/>
</element>
<!-- function Visibility: default -->
<element name="CPConvert">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="CPConvert.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CPConvert.s">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CPConvert.from">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="CPConvert.toC">
<short/>
</element>
<!-- function Visibility: default -->
<element name="GetDefaultCodepage">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="GetDefaultCodepage.Result">
<short/>
</element>
<element name="GuessEncoding">
<short>Guess character encoding of a string.</short>
<descr>The returned encoding can be used with other functions of this unit. GuessEncoding uses some heuristics to find out a good encoding. For example it checks for magic numbers like UTF BOM. Next it checks if it could be UTF-8. Finally it returns the system encoding.
This function can be used to find the encoding of text files.</descr>
</element>
<element name="ConvertEncoding">
<short>Converts the character encoding of a string</short>
<descr>ConvertEncoding uses has tables to convert between almost any desired encoding. The parameters for this function are:
s - The string to be convert
FromEncoding - The encoding of the string s
ToEncoding - The encoding of the result
The encodings are specified as string values, and the following values are currently supported:
'utf8' - UTF-8, the standard Unicode encoding of the LCL
'ansi' - Ansi represents whatever is the current system locale in a single-byte or multi-byte encoding, but never in a word encoding like UTF-16
'utf8bom' - Indicates that the text is in UTF-8 and starts with a UTF-8 byte order mark
'ucs2le' - UCS 2 encoded in little endian byte order
'ucs2be' - UCS 2 encoded in bif endian byte order
'iso88591' - ISO 8859-1 Latin 1
'iso88592' - ISO 8859-2 Latin 2
'cp1250' - CP1250
'cp1251' - CP1251
'cp1252' -
'cp1253' -
'cp1254' -
'cp1255' -
'cp1256' -
'cp1257' -
'cp1258' -
'cp437' -
'cp850' -
'cp852' -
'cp866' -
'cp874' -
'cp936' -
'cp950' -
'cp949' -
'cp932' -
'koi8' - KOI8
</descr>
</element>
<element name="GetDefaultTextEncoding">
<short>Returns the common text encoding of the current operating system.</short>
<descr>At the moment it gives:
Under Windows it returns the windows codepage.
Under Darwin (Mac OS X) it returns UTF-8.
Under all other Unix (e.g. Linux, BSD, Solaris) it uses the environment variables LC_LANG, LC_MESSAGE, and LANG. This is nowadays typically UTF-8.</descr>
</element>
<element name="NormalizeEncoding">
<short>Trims, shorten and lower case the given encoding</short>
</element>
<element name="GetSupportedEncodings">
<short>Fills the list with all basic encodings</short>
<descr>It does not add all encodings that are supported by the operating system. For example iconv under Linux supports hundreds of encodings.</descr>
</element>
</module>
<!-- LConv -->
</package>
</fpdoc-descriptions>