Kaydet (Commit) 85f4d5e7 authored tarafından Aurimas Fišeras's avatar Aurimas Fišeras Kaydeden (comit) Cédric Bosdonnat

Some fixes to documentation (part 3)

Fixes many spelling errors (checked with en_US spell checker).
Unifies spelling of some common words.
Replaces single quotes ('') with double quotes ("").
Fixes several other errors.
üst 5c0a22ab
......@@ -63,7 +63,7 @@
//=============================================================================
// DocMerge from xml: service com::sun::star::drawing::PolyPolygonBezierShape
/** This service specifies a polypolygon Bezier shape.
/** This service specifies a poly-polygon Bezier shape.
*/
published service PolyPolygonBezierShape
{
......
......@@ -42,8 +42,8 @@
//=============================================================================
/** This service describes a polypolygon.
<p>A polypolygon consists of multiple polygons combined in one.</p>
/** This service describes a poly-polygon.
<p>A poly-polygon consists of multiple polygons combined in one.</p>
*/
published service PolyPolygonDescriptor
{
......
......@@ -63,7 +63,7 @@
//=============================================================================
/** This service is for a polygon shape.
<p>A polypolygon has 2 or more straight lines, with the first and
<p>A poly-polygon has 2 or more straight lines, with the first and
last point connected by a straight line.</p>
*/
published service PolyPolygonShape
......
......@@ -42,8 +42,8 @@ interface XCsvLogFormatter;
The sequence number, the thread ID, the time of the logged event,
the source class/method name will get logged alongside the message, if this
is not disabled. The Formatter also supports logging an arbitrary number of
userdefined columns. If the Formatter is configured to have more than one
(userdefined) column the data to log has to be preformatted with the
user-defined columns. If the Formatter is configured to have more than one
(user-defined) column the data to log has to be preformatted with the
formatMultiColumn method.</p>
@since OOo 3.0
......
......@@ -47,7 +47,7 @@ module com { module sun { module star { module logging {
*/
interface XConsoleHandler : XLogHandler
{
/** renotes the <type>LogLevel</type> threshold used to determine to which
/** denotes the <type>LogLevel</type> threshold used to determine to which
console the events should be logged.
<p>Events with a level greater or equal to <code>Threshold</code> will be
......
......@@ -42,7 +42,7 @@ module com { module sun { module star { module logging {
//=============================================================================
/** specifies the interface used for formatting log records for RFC4180 csv
/** specifies the interface used for formatting log records for RFC4180 CSV
output
@see XLogFormatter, XLogHandler
......@@ -66,7 +66,7 @@ interface XCsvLogFormatter : XLogFormatter
<code>formatMultiColumn</code>*/
[attribute] sequence< string > Columnnames;
/** if the CsvLogFormatter is set to have more than one
column, any logged infomation has to be send through this
column, any logged information has to be send through this
method before calling log(). E.g.:
<code>XLoggerInstance.log(1000, XCsvLogFormatterInstance.formatMultiColumn(column_data))</code>
......
......@@ -46,7 +46,7 @@ module com { module sun { module star { module logging {
//=============================================================================
/** provides possibilites to send <type>LogRecord</type>s to an arbitrary output
/** provides possibilities to send <type>LogRecord</type>s to an arbitrary output
channel.
@see XLogger
......
......@@ -46,7 +46,7 @@ interface XLogHandler;
<a href="http://java.sun.com/javase/6/docs/api/java/util/logging/package-summary.html">Java
Logging API</a>. However, there are some differences, the major ones being:
<ul><li>There's no support (yet) for filtering log events.</li>
<li>There ain't no convenience menthods for logging.</li>
<li>There ain't no convenience methods for logging.</li>
<li>There's no localization support.</li>
<li>Logger instances do not form a hierarchy.</li>
</ul></p>
......@@ -87,7 +87,7 @@ interface XLogger
@param LogHandler
the handler to remove from the list of handlers. The call is ignored if this
parameter is <NULL/>, or if the handler has not previously beed added.
parameter is <NULL/>, or if the handler has not previously been added.
*/
void removeLogHandler( [in] XLogHandler LogHandler );
......
......@@ -48,7 +48,7 @@ struct MailAttachment
It is expected that the transferable delivers the data as
sequence of bytes. Although a transferable may support
multiple data flavors only the first data flavor supplied
will be used to retrive the data and it is expected that
will be used to retrieve the data and it is expected that
the type of the data is a sequence of bytes.
@see ::com::sun::star::datatransfer::XTransferable
......
......@@ -90,12 +90,12 @@ interface XMailMessage: ::com::sun::star::uno::XInterface {
void addCcRecipient([in] string sRecipientAddress);
/**
Add an Bcc recipients e-mail address to the list of recipients of this mail message.
Add an BCC recipients e-mail address to the list of recipients of this mail message.
If the e-mail address doesn't conform to <a href="http://www.ietf.org/rfc/rfc822.txt">RFC&nbsp;822</a>
sending the mail message will fail.
@param sRecipientAddress
[in] the e-mail address of the Bcc recipient.
[in] the e-mail address of the BCC recipient.
*/
void addBccRecipient([in] string sRecipientAddress);
......@@ -112,7 +112,7 @@ interface XMailMessage: ::com::sun::star::uno::XInterface {
sequence<string> getCcRecipients();
/**
Return a sequence of the e-mail addresses of all the Bcc recipients
Return a sequence of the e-mail addresses of all the BCC recipients
of this mail message.
*/
sequence<string> getBccRecipients();
......
......@@ -114,7 +114,7 @@ interface XMailServer: ::com::sun::star::uno::XInterface {
/**
Returns all connection types which are supported by the
mail server. Possible connection types are for instance
secure connections like 'SSL' or 'TLS'.
secure connections like "SSL" or "TLS".
@returns
a sequence of supported connection types.
......@@ -228,7 +228,7 @@ interface XMailServer: ::com::sun::star::uno::XInterface {
com::sun::star::mail::MailException);
/**
Logoff the currently logged in user.
Log off the currently logged in user.
@throws com::sun::star::mail::MessagingException
if errors occur during logoff.
......@@ -263,7 +263,7 @@ interface XMailServer: ::com::sun::star::uno::XInterface {
@throws com::sun::star::datatransfer::UnsupportedFlavorException
is thrown when the body of the mail message is provided in an
unsupported mime content type or may be thrown if one of the file
attachments specifies an unspupported mime content type.
attachments specifies an unsupported mime content type.
@see com::sun::star::io::NotConnectedExceptionException
@see com::sun::star::mail::SendMailMessageFailedException
......
......@@ -93,7 +93,7 @@ interface XMailService: ::com::sun::star::uno::XInterface {
connection types are (the values should be handled
case insensitive):
"Insecure" - insecure connections
"Ssl" - Secure Socket Layer 2.0/3.0 based connection
"SSL" - Secure Socket Layer 2.0/3.0 based connection
@returns
a sequence of supported connection types.
......@@ -121,7 +121,7 @@ interface XMailService: ::com::sun::star::uno::XInterface {
void removeConnectionListener([in] XConnectionListener xListener);
/**
Return the context of the current connnection. The context
Return the context of the current connection. The context
contains information like the server name, port, connection type
etc.
......@@ -147,8 +147,8 @@ interface XMailService: ::com::sun::star::uno::XInterface {
@param xConnectionContext
[in] an interface used to query for connection related information.
The context must contain the following values:
"ServerName" of type 'string', "Port" of type 'long', "ConnectionType"
of type 'string'. A list of supported connection types can be queried
"ServerName" of type "string", "Port" of type "long", "ConnectionType"
of type "string". A list of supported connection types can be queried
using <code>getSupportedConnectionTypes</code>.
@param xAuthenticator
......
......@@ -90,7 +90,7 @@ interface XSmtpService: ::com::sun::star::mail::XMailService {
@throws com::sun::star::datatransfer::UnsupportedFlavorException
is thrown when the body of the mail message is provided in an
unsupported mime content type or may be thrown if one of the file
attachments specifies an unspupported mime content type.
attachments specifies an unsupported mime content type.
@see com::sun::star::mail::XMailMessage
@see com::sun::star::io::NotConnectedException
......
......@@ -44,7 +44,7 @@ module awt {};
<p>Making a class accessible starts by supporting the <type
scope="::com::sun::star::accessibility">XAccessible</type> interface.
This interface' only method returns the actual accessibility object, an
This interface's only method returns the actual accessibility object, an
instance of <type
scope="::com::sun::star::accessibility">XAccessibleContext</type>.
These two interfaces may be implemented by the same class in which case
......@@ -159,7 +159,7 @@ module setup {};
/// Spreadsheet specific interfaces.
module sheet {};
/// Formatting and layout style and stylesheet interfaces.
/// Formatting and layout style and style sheet interfaces.
module style {};
/// Interfaces for import/export of Scaleable Vector Format.
......@@ -192,7 +192,7 @@ module ui {};
/// Miscellaneous interfaces for sorting, connecting objects etc.
module util {};
/// Document view specfic interfaces (e.g. selection access and printing).
/// Document view specific interfaces (e.g. selection access and printing).
module view {};
/// XML related interfaces.
......@@ -204,7 +204,7 @@ module system {};
/// Package file format interfaces.
module packages {};
/// image manupulation interfaces.
/// image manipulation interfaces.
module image {};
/// interfaces for XForms (XML-based forms) implementation
......
......@@ -43,7 +43,7 @@
// DocMerge from xml: method com::sun::star::mozilla::XPluginInstance::start
/** Allows to controll an office side plugin instance and to communicate with it.
/** Allows to control an office side plugin instance and to communicate with it.
This interface is oriented for communication with browsers plugins.
*/
published interface XPluginInstance: com::sun::star::uno::XInterface
......@@ -117,7 +117,7 @@ published interface XPluginInstance: com::sun::star::uno::XInterface
/** Notifies the plugin of a new url to open as document.
@param MIMEDesc [in]: the MIMEtype of the data stream
@param theURL [in]: the URL to be openend
@param theURL [in]: the URL to be opened
@param filter [in]: a filter string to suggest a component that should handle the document
@param sessiondata [in]: the data specifying the current session
......@@ -128,7 +128,7 @@ published interface XPluginInstance: com::sun::star::uno::XInterface
// DocMerge from idl: method com::sun::star::mozilla::XPluginInstance::getHttpServerURL
/** Retrieves the URL of the HTTP Loadbalancing Slave.
/** Retrieves the URL of the HTTP Load balancing Slave.
@param aURL [out]: the full qualified host name of the LBS
@param aPort [out]: the port number
......
......@@ -105,7 +105,7 @@ published interface XPluginInstancePeer: com::sun::star::uno::XInterface
@param MIMEDesc [in]: the MIME type of the plug-in to create
@param target [in]: the name of the target window or frame (supports _blank, _self)
@param data [in]: on success the outputstream will be associated with this instance
@param data [in]: on success the output stream will be associated with this instance
*/
[oneway] void newStream(
......
......@@ -42,7 +42,7 @@
//=============================================================================
// DocMerge from xml: interface com::sun::star::mozilla::XPluginInstanceSyncPeer
/** This interface is an extention for <type>XPluginInstancePeer</type> interface.
/** This interface is an extension for <type>XPluginInstancePeer</type> interface.
An object can support this interface in addition to <type>XPluginInstancePeer</type> interface.
*/
published interface XPluginInstanceSyncPeer : com::sun::star::uno::XInterface
......
......@@ -40,7 +40,7 @@
/** is the interface to bootup and switch Mozilla/Thunderbird profiles
/** is the interface to boot up and switch Mozilla/Thunderbird profiles
@see com::sun::star::mozilla::MozillaProductType
@see com::sun::star::mozilla::XProfileDiscover
......@@ -50,14 +50,14 @@ published interface XProfileManager: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::mozilla::XProfileManager::bootupProfile
/** attempts to init xpcom runtime using given profile.
/** attempts to init XPCOM runtime using given profile.
@param product
is the product to start up.
@param profileName
the profile name to be used.
@returns
the current refrence count for the given profile.
the current reference count for the given profile.
*/
long bootupProfile( [in]MozillaProductType product,[in]string profileName);
......@@ -65,7 +65,7 @@ published interface XProfileManager: com::sun::star::uno::XInterface
/** attempts to shutdown the current profile.
@returns
the current refrence count for the current profile.
the current reference count for the current profile.
*/
long shutdownProfile();
......
......@@ -41,7 +41,7 @@
published interface XCodeProxy;
// DocMerge from xml: interface com::sun::star::mozilla::XProxyRunner
/** is the interface run Mozilla XPCOM code in a managered environment
/** is the interface run Mozilla XPCOM code in a managed environment
@see com::sun::star::mozilla::XProfileDiscover
@see com::sun::star::mozilla::MozillaBootstrap
......@@ -50,7 +50,7 @@ published interface XProxyRunner: com::sun::star::uno::XInterface
{
// DocMerge from xml: method com::sun::star::mozilla::XProxyRunner::Run
/** attempts to Run XPCOM code in a managered environment
/** attempts to Run XPCOM code in a managed environment
@param aCode
is a com:sun:star:mozilla:XCodeProxy object to be run.
......
......@@ -35,7 +35,7 @@ interface XCoreController;
//=============================================================================
/** specifies a service controlling the core components of the Openoffice.org
/** specifies a service controlling the core components of the OpenOffice.org
improvement program. The OOo improvement program extension has to implement
this service.
......
......@@ -55,14 +55,14 @@ module com { module sun { module star { module packages {
Each instance is created with an argument which specifies the URL of
the Package file to which the user requires access. If the instance is
created without arguments, it must be initialised with the
created without arguments, it must be initialized with the
<type scope="com::sun::star::lang">XInitialization</type> service methods
before it is a valid instance of the service.
*/
published service Package
{
/**
A Package can be initialised with one of the following:
A Package can be initialized with one of the following:
1. A file URL referring to a package.
2. An XInputStream referring to a package (it must also
......@@ -71,9 +71,9 @@ published service Package
an XSeekable interface, and the XOutputStream must support an
XTruncate interface.
It will throw a css::uno::Exception if initialised with bad data or
if the package has an invalid format (for example, a corrupt central d
irectory record if the file is a ZIP file).
It will throw a css::uno::Exception if initialized with bad data or
if the package has an invalid format (for example, a corrupt central
directory record if the file is a ZIP file).
*/
interface com::sun::star::lang::XInitialization;
/**
......
......@@ -43,7 +43,7 @@
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_container_XEnumerationAccess_udl__
#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif
//=============================================================================
......@@ -98,7 +98,7 @@ published service PackageFolder
/**
This interface provides access to the properties of the package entry.
Currently, this only supports one entry which is a string called
MediaType. This contains the MIME type of the stream (eg. "text/html").
MediaType. This contains the MIME type of the stream (e.g. "text/html").
For PackageFolders, this is always an empty string.
*/
interface com::sun::star::beans::XPropertySet;
......
......@@ -92,7 +92,7 @@ interface XDataSinkEncrSupport: com::sun::star::uno::XInterface
In case stream is not encrypted an exception will be thrown.
<p>
The difference of raw stream is that it contains header for encrypted data,
so an encrypted stream can be copyed from one PackageStream to
so an encrypted stream can be copied from one PackageStream to
another one without decryption.
</p>
......
......@@ -41,7 +41,7 @@ module com { module sun { module star { module packages { module manifest {
//=============================================================================
/** This interface reads the manifest data from a file. The user
must supply an XInputStream when calling readManifestSequence() to recieve
must supply an XInputStream when calling readManifestSequence() to receive
a sequence of manifest entries. Each manifest entry is represented by
a sequence of PropertyValues. */
//=============================================================================
......
......@@ -50,7 +50,7 @@ module com { module sun { module star { module packages { module zip {
//=============================================================================
/** allows to get reading access to nonencrypted entries inside zip file.
/** allows to get reading access to non-encrypted entries inside zip file.
*/
interface XZipFileAccess: ::com::sun::star::uno::XInterface
{
......@@ -59,8 +59,8 @@ interface XZipFileAccess: ::com::sun::star::uno::XInterface
<p>
The first stream with a name that fits to the pattern will be returned.
The pattern allows to use '*' wildcard symbol. If the name contains '*'
or '\' symbols itself they must guarded with backslash '\'.
The pattern allows to use "*" wildcard symbol. If the name contains "*"
or "\" symbols itself they must guarded with backslash "\".
The slashes have no special meaning here so they can be replaced
by wildcards also.
</p>
......
......@@ -159,7 +159,7 @@ published constants ZipConstants
const short LOCTIM = 10;
//-------------------------------------------------------------------------
/** LOC header field "crc of uncompressed data" offset
/** LOC header field "CRC of uncompressed data" offset
*/
const short LOCCRC = 14;
......@@ -184,7 +184,7 @@ published constants ZipConstants
const short LOCEXT = 28;
//-------------------------------------------------------------------------
/** EXT header field "crc of uncompressed data" offsets
/** EXT header field "CRC of uncompressed data" offsets
*/
const short EXTCRC = 4;
......@@ -229,7 +229,7 @@ published constants ZipConstants
const short CENDAT = 14;
//-------------------------------------------------------------------------
/** CEN header field "crc of uncompressed data" offset
/** CEN header field "CRC of uncompressed data" offset
*/
const short CENCRC = 16;
......
......@@ -75,7 +75,7 @@ published struct ZipEntry
long nTime;
//-------------------------------------------------------------------------
/** crc-32 of entry data
/** CRC-32 of entry data
*/
long nCrc;
......
......@@ -54,7 +54,7 @@ module com { module sun { module star { module packages { module zip {
//=============================================================================
/** allows to get reading access to nonencrypted entries inside zip file.
/** allows to get reading access to non-encrypted entries inside zip file.
*/
service ZipFileAccess
{
......
......@@ -38,7 +38,7 @@ module com { module sun { module star { module packages { module zip {
//=============================================================================
/** used to indicate that a ZIP exception has occurred.
usualy can be thrown from XInputStream interface implementations.
Usually can be thrown from XInputStream interface implementations.
<p>This interface is an IDL version of the Java interface
<em>java.util.zip.ZipException</em> with some minor adaptations.</p>
......
......@@ -45,7 +45,7 @@
/** This service is implemented by the chart presentation shape.
<p>Presentation shapes can be used in a presentation
page layouts and theire position and size is by default set
page layouts and their position and size is by default set
by the presentation shapes on the <type scope="com::sun::star::drawing">MasterPage</type>.
*/
published service ChartShape
......
......@@ -95,7 +95,7 @@ published enum ClickAction
//-------------------------------------------------------------------------
/** An ole verb is performed on this object.
/** An OLE verb is performed on this object.
*/
VERB,
......
......@@ -45,7 +45,7 @@
/** This service is implemented by the date and time presentation shape.
<p>Presentation shapes can be used in a presentation
page layouts and theire position and size is by default set
page layouts and their position and size is by default set
by the presentation shapes on the <type scope="com::sun::star::drawing">MasterPage</type>.
*/
service DateTimeShape
......
......@@ -107,7 +107,7 @@ published service DocumentSettings
/** If this is true, the distance between two paragraphs is
the sum of ParaTopMargin of the previous and ParaBottomMargin of
the next paragraph. If false, only the greater of the two is
choosen.
chosen.
*/
[optional, property] boolean ParagraphSummation;
......
......@@ -111,7 +111,7 @@ published service DrawPage
//-------------------------------------------------------------------------
/** defines the text that is displayd in a header textfield rendered on this
/** defines the text that is displayed in a header textfield rendered on this
page.
*/
[optional, property] string HeaderText;
......@@ -126,7 +126,7 @@ published service DrawPage
//-------------------------------------------------------------------------
/** defines the text that is displayd in a footer textfield rendered on this
/** defines the text that is displayed in a footer textfield rendered on this
page.
*/
[optional, property] string FooterText;
......@@ -157,7 +157,7 @@ published service DrawPage
//-------------------------------------------------------------------------
/** defines the text that is displayd in a date and time textfield rendered on this
/** defines the text that is displayed in a date and time textfield rendered on this
page. This value is only used if <code>IsDateTimeFixed</code> is <true/>.
*/
[optional, property] string DateTimeText;
......
......@@ -42,7 +42,7 @@ constants EffectCommands
*/
const short CUSTOM = 0;
/** the command is an ole verb.
/** the command is an OLE verb.
Required parameters are
"Verb" of type long that specifies the verb to execute.
*/
......@@ -51,7 +51,7 @@ constants EffectCommands
/** the command starts playing on a media object.
Optional parameters are
"MediaTime" of type double that specifies the start
time in mili seconds. If not given, play continues at
time in milliseconds. If not given, play continues at
last position known.
*/
const short PLAY = 2;
......
......@@ -38,8 +38,8 @@
This is stored with the name <i>node-type</i> inside the
<member>::com::sun::star::animations::XAnimationNode::UserData</member> sequence.
<br>
This does not manipulate the timing or syncronization.
It can be used to quickly identify semantic blocks inside an animation hierachy.
This does not manipulate the timing or synchronization.
It can be used to quickly identify semantic blocks inside an animation hierarchy.
@see ::com::sun::star::animations::AnimationNode
*/
......@@ -61,7 +61,7 @@ constants EffectNodeType
*/
const short AFTER_PREVIOUS = 3;
/** This is the main sequence for effects that is automaticaly started.
/** This is the main sequence for effects that is automatically started.
*/
const short MAIN_SEQUENCE = 4;
......
......@@ -38,8 +38,8 @@
This is stored with the name <i>preset-class</i> inside the
<member>::com::sun::star::animations::XAnimationNode::UserData</member> sequence.
<br>
This does not manipulate the timing or syncronization.
It can be used to quickly identify preset animations inside an animation hierachy.
This does not manipulate the timing or synchronization.