fpc/packages/fcl-res/xml/externalwriter.xml
michael 174de3eab1 Merged revisions 9693-10480 via svnmerge from
svn+ssh://svn.freepascal.org/FPC/svn/fpc/branches/resources

........
  r9694 | michael | 2008-01-09 21:31:18 +0100 (Wed, 09 Jan 2008) | 1 line
  
  * Initial check-in
........
  r9695 | michael | 2008-01-09 21:35:58 +0100 (Wed, 09 Jan 2008) | 1 line
  
  * New version from Giulio Bernardi
........
  r9697 | michael | 2008-01-09 21:41:54 +0100 (Wed, 09 Jan 2008) | 1 line
  
  * Patch from Giulio Bernardi with resource support
........
  r9698 | michael | 2008-01-09 21:46:33 +0100 (Wed, 09 Jan 2008) | 1 line
  
  * Patch from Giulio Bernardi to add more resource testing
........
  r9699 | michael | 2008-01-09 21:57:26 +0100 (Wed, 09 Jan 2008) | 1 line
  
  * New tool from Giulio Bernardi
........
  r9700 | michael | 2008-01-09 21:58:23 +0100 (Wed, 09 Jan 2008) | 1 line
  
  * New tool from Giulio Bernardi
........
  r9701 | michael | 2008-01-09 22:01:54 +0100 (Wed, 09 Jan 2008) | 1 line
  
  * Added fcl-res
........
  r9702 | michael | 2008-01-09 22:01:58 +0100 (Wed, 09 Jan 2008) | 1 line
  
  * Added fcl-res
........
  r9703 | michael | 2008-01-10 08:54:26 +0100 (Thu, 10 Jan 2008) | 1 line
  
  * Fixed double code
........
  r9704 | jonas | 2008-01-10 10:59:20 +0100 (Thu, 10 Jan 2008) | 2 lines
  
    - removed duplicate code
........
  r9705 | jonas | 2008-01-10 11:25:21 +0100 (Thu, 10 Jan 2008) | 2 lines
  
    + added missing fcl-res dependencies
........
  r9706 | jonas | 2008-01-10 11:58:30 +0100 (Thu, 10 Jan 2008) | 2 lines
  
    + dependencies for fpintres and fpextres
........
  r9707 | yury | 2008-01-10 12:47:51 +0100 (Thu, 10 Jan 2008) | 3 lines
  
  * Fixed compilation of resource, which is included in a unit located in different folder than main source.
  * .res files must be copied to units output folder, otherwise .res files will not be found when only compiled units path is available and compiler does not know anything about sources folder.
  * Improved resource related error messages.
........
  r9708 | michael | 2008-01-10 12:52:13 +0100 (Thu, 10 Jan 2008) | 1 line
  
  * Removed double source after end.
........
  r9709 | michael | 2008-01-10 12:52:48 +0100 (Thu, 10 Jan 2008) | 1 line
  
  * No longer needed
........
  r9710 | tom_at_work | 2008-01-10 22:09:08 +0100 (Thu, 10 Jan 2008) | 1 line
  
  * properly align FPC_RESLOCATION so that linking does not fail on some architectures (e.g. ppc64)
........
  r9711 | tom_at_work | 2008-01-10 23:53:12 +0100 (Thu, 10 Jan 2008) | 1 line
  
  * fix splitting of 64 bit load/stores from/to unaligned memory locations into multiple load/stores, which in some cases generated wrong code
........
  r9712 | michael | 2008-01-11 11:00:08 +0100 (Fri, 11 Jan 2008) | 1 line
  
  * Fixed bug in BSS section on 64-bit platforms
........
  r9720 | giulio | 2008-01-12 10:02:04 +0100 (Sat, 12 Jan 2008) | 1 line
  
  Updated fcl-res documentation: occurrences of reslib changed to fcl-res.
........
  r9740 | giulio | 2008-01-13 19:36:44 +0100 (Sun, 13 Jan 2008) | 3 lines
  
   - Don't try to compile resources on systems with a non windows-like resource support.
   - Don't add the .or file to the list of object files if resource compiling failed.
........
  r10201 | giulio | 2008-02-04 11:35:44 +0100 (Mon, 04 Feb 2008) | 5 lines
  
  * resource compiling supported on OS/2 via wrc
  * CompileResourceFiles and CollectResourceFiles don't do target-specific checks anymore
  * refactored a bit
........
  r10389 | giulio | 2008-02-25 21:32:52 +0100 (Mon, 25 Feb 2008) | 2 lines
  
  Deleted test file which was committed by mistake
........
  r10472 | giulio | 2008-03-10 12:22:18 +0100 (Mon, 10 Mar 2008) | 2 lines
  
  changed define FPC_HAS_RESOURCES to FPC_HAS_WINLIKERESOURCES
........

git-svn-id: trunk@10481 -
2008-03-12 21:33:48 +00:00

98 lines
4.0 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fcl-res">
<!--
====================================================================
externalwriter
====================================================================
-->
<module name="externalwriter">
<short>Contains a resource writer for external resource files</short>
<descr>
<p>This unit contains <link id="TExternalResourceWriter"/>, a <link id="resource.TAbstractResourceWriter">TAbstractResourceWriter</link> descendant that is able to write standalone resource files in a Free Pascal-specific format.</p>
<p>Adding this unit to a program's <var>uses</var> clause registers class <link id="TExternalResourceWriter"/> with <link id="resource.TResources">TResources</link>.</p>
<p><b>See also</b></p>
<p><link id="externaltypes.Free Pascal external resource file format description">Free Pascal external resource file format description</link></p>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
</element>
<!-- unresolved type reference Visibility: default -->
<element name="resource">
</element>
<!-- unresolved type reference Visibility: default -->
<element name="resourcetree">
</element>
<!-- unresolved type reference Visibility: default -->
<element name="externaltypes">
</element>
<!-- object Visibility: default -->
<element name="EExternalResourceWriterException">
<short>Base class for external resource writer-related exceptions</short>
</element>
<!-- object Visibility: default -->
<element name="EExternalResInvalidEndianessException">
<short>Invalid endianess error</short>
<descr>
<p>This exception is raised when an attempt is made to set <link id="TExternalResourceWriter.Endianess">Endianess</link> property of a <link id="TExternalResourceWriter"/> object to a value other than <link id="externaltypes.EXT_ENDIAN_BIG">EXT_ENDIAN_BIG</link> or <link id="externaltypes.EXT_ENDIAN_LITTLE">EXT_ENDIAN_LITTLE</link>.</p>
</descr>
<seealso>
<link id="TExternalResourceWriter.Endianess"/>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TExternalResStringTable">
<short>External resource file string table</short>
<descr>
<p>This class is used internally by <link id="TExternalResourceWriter"/>.</p>
</descr>
</element>
<!-- object Visibility: default -->
<element name="TExternalResourceWriter">
<short>External file resource writer</short>
<descr>
<p>This class provides a writer for .fpcres files: they are standalone files containing resources.</p>
<p>Standalone files are files that don't get linked with the final executable. They are used as a
fallback solution on all those platforms for which an internal resource format is not available.</p>
<p>At runtime the resource file is read by Free Pascal RTL to provide resource support to the application.</p>
<p><link id="TExternalResourceWriter.Endianess">Endianess</link> property can be used to set the byte order to use in the file to generate.</p>
</descr>
<seealso>
<link id="TExternalResourceWriter.Endianess"/>
<link id="resource.TAbstractResourceWriter">TAbstractResourceWriter</link>
<link id="externalreader.TExternalResourceReader">TExternalResourceReader</link>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TExternalResourceWriter.Endianess">
<short>The byte order to use in the file</short>
<descr>
<p>This property can be used to set the byte order (endianess) of the file to write.</p>
<remark>If a value other than <link id="externaltypes.EXT_ENDIAN_BIG">EXT_ENDIAN_BIG</link> or <link id="externaltypes.EXT_ENDIAN_LITTLE">EXT_ENDIAN_LITTLE</link> is used, an <link id="EExternalResInvalidEndianessException"/> exception is raised.</remark>
</descr>
<seealso>
<link id="externaltypes.EXT_ENDIAN_BIG">EXT_ENDIAN_BIG</link>
<link id="externaltypes.EXT_ENDIAN_LITTLE">EXT_ENDIAN_LITTLE</link>
</seealso>
</element>
</module> <!-- externalwriter -->
</package>
</fpdoc-descriptions>