Neil Roberts
50c63a7497
A bunch of places in the documentation in the IDL files were starting a
new paragraph with a <p> tag and a line that is more indented than the
previous one. This ends up making a preformatted code section in a
monospace font in the generated HTML docs and the <p> tag is visible.
This patch just moves the lines to the left to have the same indentation
as the previous one. These were found by running the following Python
script on the generated HTML files:
from bs4 import BeautifulSoup
import sys
for filename in sys.argv[1:]:
with open(filename) as fp:
soup = BeautifulSoup(fp, 'html.parser')
for pre in soup.find_all("pre", class_="fragment"):
if pre.string.find("<p>") != -1:
print(f"{filename}:{pre.sourceline}:"
f"{str(pre).split('\n')[0]}")
Change-Id: If351a5be24b21b24a4d7892a9185353e8691feb1
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/201134
Tested-by: Jenkins
Reviewed-by: Neil Roberts <bpeeluk@yahoo.co.uk>
116 lines
4.3 KiB
Plaintext
116 lines
4.3 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
|
|
|
|
module com { module sun { module star { module script {
|
|
|
|
/** gives access to an object's methods and properties.
|
|
Container access is available through
|
|
com::sun::star::container::XIndexContainer,
|
|
com::sun::star::container::XNameContainer and
|
|
com::sun::star::container::XEnumerationAccess.
|
|
</p>
|
|
*/
|
|
published interface XInvocation: com::sun::star::uno::XInterface
|
|
{
|
|
/** returns the introspection from this object or `NULL`
|
|
if the object does not provide this information.
|
|
*/
|
|
com::sun::star::beans::XIntrospectionAccess getIntrospection();
|
|
|
|
/** provides access to methods exposed by an object.
|
|
|
|
@param aFunctionName the method to invoke
|
|
@param aParams all parameters; pure out params are undefined in sequence,
|
|
the value has to be ignored by the callee
|
|
@param aOutParamIndex This sequence contains the indices of all parameters
|
|
that are specified as out or inout.
|
|
@param aOutParam This sequence contains the values of all parameters that
|
|
are specified as out or inout and corresponds with the
|
|
indices provided by the aOutParamIndex sequence.
|
|
|
|
Example: aOutParamIndex == { 1, 4 } means that
|
|
aOutParam[0] contains the out value of the aParams[1]
|
|
parameter and aOutParam[1] contains the out value of
|
|
the aParams[4] parameter.
|
|
*/
|
|
any invoke( [in] string aFunctionName,
|
|
[in] sequence<any> aParams,
|
|
[out] sequence<short> aOutParamIndex,
|
|
[out] sequence<any> aOutParam )
|
|
raises( com::sun::star::lang::IllegalArgumentException,
|
|
com::sun::star::script::CannotConvertException,
|
|
com::sun::star::reflection::InvocationTargetException );
|
|
|
|
/** sets a value to the property with the specified name.
|
|
|
|
<p> If the underlying object implements an
|
|
com::sun::star::container::XNameContainer,
|
|
then this method will insert the value if there is no such
|
|
<var>aPropertyName</var>.
|
|
|
|
</p>
|
|
*/
|
|
void setValue( [in] string aPropertyName,
|
|
[in] any aValue )
|
|
raises( com::sun::star::beans::UnknownPropertyException,
|
|
com::sun::star::script::CannotConvertException,
|
|
com::sun::star::reflection::InvocationTargetException );
|
|
|
|
/** returns the value of the property with the specified name.
|
|
|
|
@param aPropertyName
|
|
specifies the name of the property.
|
|
*/
|
|
any getValue( [in] string aPropertyName )
|
|
raises( com::sun::star::beans::UnknownPropertyException );
|
|
|
|
/** returns `TRUE` if the method with the specified name exists, else `FALSE`.
|
|
|
|
<p>This optimizes the calling sequence
|
|
( XInvocation::hasMethod(),
|
|
XInvocation::invoke() )!</p>
|
|
|
|
@param aName
|
|
specifies the name of the method.
|
|
*/
|
|
boolean hasMethod( [in] string aName );
|
|
|
|
/** returns `TRUE` if the property with the specified name exists, else `FALSE`.
|
|
|
|
<p>This optimizes the calling sequence
|
|
( XInvocation::hasProperty(),
|
|
XInvocation::getValue() ) or
|
|
|
|
( XInvocation::hasProperty(),
|
|
XInvocation::setValue() )!
|
|
|
|
@param aName
|
|
specifies the name of the property.
|
|
*/
|
|
boolean hasProperty( [in] string aName );
|
|
|
|
};
|
|
|
|
|
|
}; }; }; };
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|