[Libreoffice-commits] core.git: 4 commits - cppuhelper/inc cppu/inc framework/inc javaunohelper/com odk/CustomTarget_autodoc.mk odk/CustomTarget_doxygen.mk odk/CustomTarget_javadoc.mk odk/pack offapi/com registry/inc sal/inc solenv/gbuild store/inc
Peter Foley
pefoley2 at verizon.net
Mon Mar 18 18:57:23 PDT 2013
cppu/inc/com/sun/star/uno/Reference.h | 4
cppu/inc/typelib/typedescription.h | 4
cppu/inc/uno/mapping.h | 6 -
cppu/inc/uno/threadpool.h | 2
cppuhelper/inc/cppuhelper/component.hxx | 4
cppuhelper/inc/cppuhelper/component_context.hxx | 2
cppuhelper/inc/cppuhelper/exc_hlp.hxx | 2
cppuhelper/inc/cppuhelper/interfacecontainer.h | 2
cppuhelper/inc/cppuhelper/propertysetmixin.hxx | 42 +++----
cppuhelper/inc/cppuhelper/propshlp.hxx | 24 +++-
cppuhelper/inc/cppuhelper/shlib.hxx | 14 +-
cppuhelper/inc/cppuhelper/weak.hxx | 2
cppuhelper/inc/cppuhelper/weakref.hxx | 4
framework/inc/services/sessionlistener.hxx | 1
javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java | 7 -
odk/CustomTarget_autodoc.mk | 3
odk/CustomTarget_doxygen.mk | 7 -
odk/CustomTarget_javadoc.mk | 5
odk/pack/copying/idl_chapter_refs.txt | 14 +-
offapi/com/sun/star/text/BaseIndex.idl | 2
registry/inc/registry/registry.h | 70 +++++++------
registry/inc/registry/registry.hxx | 5
sal/inc/osl/file.hxx | 2
sal/inc/osl/mutex.hxx | 12 +-
sal/inc/osl/security_decl.hxx | 4
sal/inc/osl/socket.h | 31 +++--
sal/inc/osl/socket_decl.hxx | 9 +
sal/inc/rtl/alloc.h | 11 +-
sal/inc/rtl/bootstrap.h | 6 -
sal/inc/rtl/cipher.h | 10 +
sal/inc/rtl/crc.h | 3
sal/inc/rtl/digest.h | 44 ++++----
sal/inc/rtl/logfile.hxx | 6 -
sal/inc/rtl/strbuf.h | 29 ++---
sal/inc/rtl/strbuf.hxx | 4
sal/inc/rtl/string.h | 14 +-
sal/inc/rtl/uri.h | 30 ++---
sal/inc/rtl/ustrbuf.h | 16 +-
sal/inc/rtl/ustrbuf.hxx | 2
sal/inc/rtl/ustring.h | 13 +-
sal/inc/sal/log.hxx | 8 +
solenv/gbuild/TargetLocations.mk | 1
solenv/gbuild/ZipPackage.mk | 2
store/inc/store/store.h | 8 -
44 files changed, 291 insertions(+), 200 deletions(-)
New commits:
commit f90f71e2685310af6461bc3ed27eb9252ea40d69
Author: Peter Foley <pefoley2 at verizon.net>
Date: Mon Mar 18 21:56:03 2013 -0400
add userfriendly targets for ZipPackage
Change-Id: I5e8876bfbca7d9c063a6200e41b31d99763a7829
diff --git a/solenv/gbuild/TargetLocations.mk b/solenv/gbuild/TargetLocations.mk
index 7434e65..2583ea0 100644
--- a/solenv/gbuild/TargetLocations.mk
+++ b/solenv/gbuild/TargetLocations.mk
@@ -234,6 +234,7 @@ gb_XcuMergeTarget_get_target = $(WORKDIR)/XcuMergeTarget/$(1)
gb_XcuResTarget_get_target = $(WORKDIR)/XcuResTarget/$(1)
gb_Zip_get_target = $(WORKDIR)/Zip/$(1).zip
gb_Zip_get_final_target = $(WORKDIR)/Zip/$(1).done
+gb_ZipPackage_get_target = $(WORKDIR)/ZipPackage/$(1)
gb_Library__get_final_target = $(WORKDIR)/Dummy/$(1)
diff --git a/solenv/gbuild/ZipPackage.mk b/solenv/gbuild/ZipPackage.mk
index f7e37e2..34c6b1d 100644
--- a/solenv/gbuild/ZipPackage.mk
+++ b/solenv/gbuild/ZipPackage.mk
@@ -23,6 +23,8 @@ $(call gb_Zip_get_outdir_bin_target,$(1)) : $(call gb_Zip_get_target,$(1))
cp $$< $$@
$(call gb_Zip_get_outdir_bin_target,$(1)) :| $(dir $(call gb_Zip_get_outdir_bin_target,$(1))).dir
$(call gb_Package_get_clean_target,$(1)) : $(call gb_Zip_get_clean_target,$(1))
+$(call gb_ZipPackage_get_target,$(1)) : $(call gb_Package_get_target,$(1))
+$(call gb_Helper_make_userfriendly_targets,$(1),ZipPackage)
endef
commit 980c1179bbde47bab53410794795781d0e61e82a
Author: Peter Foley <pefoley2 at verizon.net>
Date: Mon Mar 18 21:55:24 2013 -0400
cleanup doxygen warnings
Change-Id: I9181cad5bfa93f9e8b3d944b2b50a3ccc0b42595
diff --git a/cppu/inc/com/sun/star/uno/Reference.h b/cppu/inc/com/sun/star/uno/Reference.h
index fe1531b..94551a0 100644
--- a/cppu/inc/com/sun/star/uno/Reference.h
+++ b/cppu/inc/com/sun/star/uno/Reference.h
@@ -449,7 +449,7 @@ public:
inline void set( Any const & rAny, UnoReference_QueryThrow dummy);
/** sets the given interface
An interface already set will be released.
- Throws a RuntimeException if the source interface is <NULL/>.
+ Throws a RuntimeException if the source interface is @b NULL.
@param pInterface an interface pointer
@param dummy UNO_SET_THROW to force obvious distinction to other set methods
@@ -459,7 +459,7 @@ public:
inline void SAL_CALL set( interface_type * pInterface, UnoReference_SetThrow dummy) SAL_THROW( (RuntimeException) );
/** sets the given interface
An interface already set will be released.
- Throws a RuntimeException if the source interface is <NULL/>.
+ Throws a RuntimeException if the source interface is @b NULL.
@param rRef an interface reference
@param dummy UNO_SET_THROW to force obvious distinction to other set methods
diff --git a/cppu/inc/typelib/typedescription.h b/cppu/inc/typelib/typedescription.h
index bcc9337..89d718f 100644
--- a/cppu/inc/typelib/typedescription.h
+++ b/cppu/inc/typelib/typedescription.h
@@ -422,7 +422,6 @@ typedef struct _typelib_InterfaceAttributeTypeDescription
</ul>
*/
typedef struct _typelib_InterfaceTypeDescription
-/// @NOHTML
{
/** inherits all members of typelib_TypeDescription
*/
@@ -949,7 +948,8 @@ CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_release(
/** Retrieves the type description for a given reference. If it is not possible to resolve the
reference, null is returned.
- @param ppRet inout type description
+ @param[in,out] ppRet type description
+ @param[in] pRef type description reference
*/
CPPU_DLLPUBLIC void SAL_CALL typelib_typedescriptionreference_getDescription(
typelib_TypeDescription ** ppRet, typelib_TypeDescriptionReference * pRef )
diff --git a/cppu/inc/uno/mapping.h b/cppu/inc/uno/mapping.h
index 1f3828a..179f41f 100644
--- a/cppu/inc/uno/mapping.h
+++ b/cppu/inc/uno/mapping.h
@@ -177,9 +177,9 @@ CPPU_DLLPUBLIC void SAL_CALL uno_getMappingByName(
/** Function pointer declaration to get a mapping from a loaded bridge. Bridges export a function
called uno_ext_getMapping() of this signature.
- @param ppMapping [inout] mapping; existing mapping will be released
- @pFrom source environment
- @pTo destination environment
+ @param[in,out] ppMapping mapping; existing mapping will be released
+ @param[in] pFrom source environment
+ @param[in] pTo destination environment
*/
typedef void (SAL_CALL * uno_ext_getMappingFunc)(
struct _uno_Mapping ** ppMapping,
diff --git a/cppu/inc/uno/threadpool.h b/cppu/inc/uno/threadpool.h
index 973fa54..6e880e5 100644
--- a/cppu/inc/uno/threadpool.h
+++ b/cppu/inc/uno/threadpool.h
@@ -108,6 +108,7 @@ uno_threadpool_enter( uno_ThreadPool hPool , void **ppJob )
/**
Detaches the current thread from the threadpool. Must be called for
every call to uno_threadpool_attach.
+ @param hPool the handle that was previously created by uno_threadpool_create().
*/
CPPU_DLLPUBLIC void SAL_CALL
uno_threadpool_detach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
@@ -132,6 +133,7 @@ uno_threadpool_detach( uno_ThreadPool hPool ) SAL_THROW_EXTERN_C();
If pJob is a reply, there MUST be a thread with the given threadId waiting
for this reply.
+ @param hPool the handle that was previously created by uno_threadpool_create().
@param pThreadId The Id of the thread, that initialized this request. (In general a
remote threadid).
@param pJob The argument, that doRequest will get or that will be returned by
diff --git a/cppuhelper/inc/cppuhelper/component.hxx b/cppuhelper/inc/cppuhelper/component.hxx
index 115f39a..6446095 100644
--- a/cppuhelper/inc/cppuhelper/component.hxx
+++ b/cppuhelper/inc/cppuhelper/component.hxx
@@ -33,9 +33,9 @@
namespace cppu
{
-/** Deprecated. Helper for implementing ::com::sun::star::lang::XComponent.
+/** Deprecated. Helper for implementing com::sun::star::lang::XComponent.
Upon disposing objects of this class, sub-classes receive a disposing() call. Objects of
- this class can be held weakly, i.e. by a ::com::sun::star::uno::WeakReference. Object of
+ this class can be held weakly, i.e. by a com::sun::star::uno::WeakReference. Object of
this class can be aggregated, i.e. incoming queryInterface() calls are delegated.
@attention
diff --git a/cppuhelper/inc/cppuhelper/component_context.hxx b/cppuhelper/inc/cppuhelper/component_context.hxx
index 3950ccd9..575fa49 100644
--- a/cppuhelper/inc/cppuhelper/component_context.hxx
+++ b/cppuhelper/inc/cppuhelper/component_context.hxx
@@ -33,7 +33,7 @@ struct ContextEntry_Init
{
/** late init denotes a object that will be raised when first get() is calling for it
- The context implementation expects either a ::com::sun::star::lang::XSingleComponentFactory
+ The context implementation expects either a com::sun::star::lang::XSingleComponentFactory
object as value (to instanciate the object) or a string as value for raising
a service via the used service manager.
*/
diff --git a/cppuhelper/inc/cppuhelper/exc_hlp.hxx b/cppuhelper/inc/cppuhelper/exc_hlp.hxx
index 14c2b6f..9c110ee 100644
--- a/cppuhelper/inc/cppuhelper/exc_hlp.hxx
+++ b/cppuhelper/inc/cppuhelper/exc_hlp.hxx
@@ -39,6 +39,7 @@ CPPUHELPER_DLLPUBLIC void SAL_CALL throwException( const ::com::sun::star::uno::
/** Use this function to get the dynamic type of a caught C++-UNO exception;
completes the above function throwing exceptions generically.
+ @code
try
{
...
@@ -53,6 +54,7 @@ CPPUHELPER_DLLPUBLIC void SAL_CALL throwException( const ::com::sun::star::uno::
::com::sun::star::uno::Any caught( ::cppu::getCaughtException() );
...
}
+ @endcode
Restrictions:
- use only for caught C++-UNO exceptions (UNOIDL defined)
diff --git a/cppuhelper/inc/cppuhelper/interfacecontainer.h b/cppuhelper/inc/cppuhelper/interfacecontainer.h
index 9ce8c9a..6e935f3 100644
--- a/cppuhelper/inc/cppuhelper/interfacecontainer.h
+++ b/cppuhelper/inc/cppuhelper/interfacecontainer.h
@@ -196,7 +196,7 @@ public:
@tparam ListenerT listener type
@tparam FuncT unary functor type, let your compiler deduce this for you
@param func unary functor object expecting an argument of type
- ::com::sun::star::uno::Reference<ListenerT>
+ com::sun::star::uno::Reference<ListenerT>
*/
template <typename ListenerT, typename FuncT>
inline void forEach( FuncT const& func );
diff --git a/cppuhelper/inc/cppuhelper/propertysetmixin.hxx b/cppuhelper/inc/cppuhelper/propertysetmixin.hxx
index 2a05f68..15bf836 100644
--- a/cppuhelper/inc/cppuhelper/propertysetmixin.hxx
+++ b/cppuhelper/inc/cppuhelper/propertysetmixin.hxx
@@ -63,10 +63,10 @@ template< typename T > class PropertySetMixin;
/**
@short A helper base class for <code>cppu::PropertySetMixin</code>.
- @descr See the documentation of <code>cppu::PropertySetMixin</code> for
+ See the documentation of <code>cppu::PropertySetMixin</code> for
further details.
- @descr That <code>cppu::PropertySetMixin</code> is derived from this
+ That <code>cppu::PropertySetMixin</code> is derived from this
base class should be considered an implementation detail. The functionality
of <code>cppu::PropertySetMixin</code> that is inherited from this base
class and is visible to subclasses of
@@ -120,11 +120,11 @@ protected:
<code>cppu::PropertySetMixin</code> when implementing UNO interface
type attribute setter functions.
- @descr This class is not thread safe; that is, the constructor,
+ This class is not thread safe; that is, the constructor,
<code>notify</code>, and the destructor must be called from the same
thread.
- @descr See <code>cppu::PropertySetMixinImpl::prepareSet</code> for
+ See <code>cppu::PropertySetMixinImpl::prepareSet</code> for
further details.
*/
class CPPUHELPER_DLLPUBLIC BoundListeners {
@@ -132,14 +132,14 @@ protected:
/**
@short The constructor.
- @descr May throw <code>std::bad_alloc</code>.
+ May throw <code>std::bad_alloc</code>.
*/
BoundListeners();
/**
@short The destructor.
- @descr Does not throw.
+ Does not throw.
*/
~BoundListeners();
@@ -147,10 +147,10 @@ protected:
@short Notifies any
<code>com::sun::star::beans::XPropertyChangeListener</code>s.
- @descr May throw <code>com::sun::star::uno::RuntimeException</code>
+ May throw <code>com::sun::star::uno::RuntimeException</code>
and <code>std::bad_alloc</code>.
- @descr See <code>cppu::PropertySetMixinImpl::prepareSet</code>
+ See <code>cppu::PropertySetMixinImpl::prepareSet</code>
for further details.
*/
void notify() const;
@@ -170,7 +170,7 @@ protected:
<code>cppu::PropertySetMixin</code> when implementing UNO interface
type attribute setter functions.
- @descr First, this function checks whether this instance has already been
+ First, this function checks whether this instance has already been
disposed (see <code>cppu::PropertySetMixinImpl::dispose</code>),
and throws a <code>com::sun::star::lang::DisposedException</code> if
applicable. For a constrained attribute (whose setter can explicitly
@@ -187,7 +187,7 @@ protected:
Furthermore, <code>boundListeners->notify()</code> and this function have
to be called from the same thread.
- @descr May throw
+ May throw
<code>com::sun::star::beans::PropertyVetoException</code>,
<code>com::sun::star::uno::RuntimeException</code> (and
<code>com::sun::star::lang::DisposedException</code> in particular), and
@@ -201,7 +201,7 @@ protected:
<code>com::sun::star::beans::PropertyChangeEvent::OldValue</code>, which
is rather useless, anyway (see “Using the Observer Pattern”
in <a href="http://tools.openoffice.org/CodingGuidelines.sxw">
- <cite>OpenOffice.org Coding Guidelines</cite></a>). If the attribute
+ OpenOffice.org Coding Guidelines</a>). If the attribute
that is going to be set is neither bound nor constrained, or if
<code>com::sun::star::beans::PropertyChangeEvent::OldValue</code> should
not be set, a <code>VOID</code> <code>Any</code> can be used instead.
@@ -211,7 +211,7 @@ protected:
<code>com::sun::star::beans::PropertyChangeEvent::NewValue</code>, which
is rather useless, anyway (see “Using the Observer Pattern”
in <a href="http://tools.openoffice.org/CodingGuidelines.sxw">
- <cite>OpenOffice.org Coding Guidelines</cite></a>), <em>unless</em> the
+ OpenOffice.org Coding Guidelines</a>), <em>unless</em> the
attribute that is going to be set is constrained. If the attribute
that is going to be set is neither bound nor constrained, or if it is
only bound but
@@ -233,7 +233,7 @@ protected:
/**
@short Mark this instance as being disposed.
- @descr See <code>com::sun::star::lang::XComponent</code> for the general
+ See <code>com::sun::star::lang::XComponent</code> for the general
concept of disposing UNO objects. On the first call to this function,
all registered listeners
(<code>com::sun::star::beans::XPropertyChangeListener</code>s and
@@ -241,7 +241,7 @@ protected:
notified of the disposing source. Any subsequent calls to this function
are ignored.
- @descr May throw <code>com::sun::star::uno::RuntimeException</code> and
+ May throw <code>com::sun::star::uno::RuntimeException</code> and
<code>std::bad_alloc</code>.
*/
void dispose();
@@ -251,7 +251,7 @@ protected:
<code>cppu::PropertySetMixin</code> when implementing
<code>com::sun::star::uno::XInterface::queryInterface</code>.
- @descr This function checks for support of any of the UNO interface types
+ This function checks for support of any of the UNO interface types
specified in the call of the <code>cppu::PropertySetMixin</code>
constructor. It does not check for any other UNO interface types (not
even for <code>com::sun::star::uno::XInterface</code>), and should not
@@ -291,7 +291,7 @@ protected:
@short Adds a
<code>com::sun::star::beans::XPropertyChangeListener</code>.
- @descr If a listener is added more than once, it will receive all
+ If a listener is added more than once, it will receive all
relevant notifications multiple times.
@see com::sun::star::beans::XPropertySet::addPropertyChangeListener
@@ -319,7 +319,7 @@ protected:
@short Adds a
<code>com::sun::star::beans::XVetoableChangeListener</code>.
- @descr If a listener is added more than once, it will receive all
+ If a listener is added more than once, it will receive all
relevant notifications multiple times.
@see com::sun::star::beans::XPropertySet::addVetoableChangeListener
@@ -406,10 +406,10 @@ private:
@short A helper mixin to implement certain UNO interfaces related to property
set handling on top of the attributes of a given UNO interface type.
- @descr The UNO interface type is specified by the type parameter
+ The UNO interface type is specified by the type parameter
<code>T</code> (which must correspond to a UNO interface type).
- @descr No specializations of this class template should be added by client
+ No specializations of this class template should be added by client
code.
@since UDK 3.2.1
@@ -419,7 +419,7 @@ protected:
/**
@short The constructor.
- @descr May throw <code>com::sun::star::uno::RuntimeException</code> and
+ May throw <code>com::sun::star::uno::RuntimeException</code> and
<code>std::bad_alloc</code>.
@param context the component context used by this class template; must
@@ -468,7 +468,7 @@ protected:
/**
@short The destructor.
- @descr Does not throw.
+ Does not throw.
*/
~PropertySetMixin() {}
diff --git a/cppuhelper/inc/cppuhelper/propshlp.hxx b/cppuhelper/inc/cppuhelper/propshlp.hxx
index c063f81..aa99eba 100644
--- a/cppuhelper/inc/cppuhelper/propshlp.hxx
+++ b/cppuhelper/inc/cppuhelper/propshlp.hxx
@@ -317,6 +317,19 @@ public:
@param bIgnoreRuntimeExceptionsWhileFiring
indicates whether occuring RuntimeExceptions shall be
ignored when firing notifications
+ @param pnHandles the id's of the properties that changed.
+ @param nCount the number of elements in the arrays pnHandles, pNewValues and pOldValues.
+ @param bVetoable true means fire to VetoableChangeListener, false means fire to
+ XPropertyChangedListener and XMultiPropertyChangedListener.
+ @param bIgnoreRuntimeExceptionsWhileFiring
+ indicates whether occurring RuntimeExceptions will be
+ ignored when firing notifications
+ (vetoableChange(), propertyChange())
+ to listeners.
+ PropertyVetoExceptions may still be thrown.
+ This flag is useful in an inter-process scenario when
+ remote bridges may break down
+ (firing DisposedExceptions).
@see OPropertySetHelper::fire
*/
@@ -559,6 +572,7 @@ protected:
@param rConvertedValue the converted value. Only set if return is true.
@param rOldValue the old value. Only set if return is true.
@param nHandle the handle of the proberty.
+ @param rValue the value to be converted
@return true if the value converted.
*/
virtual sal_Bool SAL_CALL convertFastPropertyValue(
@@ -575,11 +589,11 @@ protected:
@attention
Although you are permitted to throw any UNO exception, only the following
are valid for usage:
- -- ::com::sun::star::beans::UnknownPropertyException
- -- ::com::sun::star::beans::PropertyVetoException
- -- ::com::sun::star::lang::IllegalArgumentException
- -- ::com::sun::star::lang::WrappedTargetException
- -- ::com::sun::star::uno::RuntimeException
+ -- com::sun::star::beans::UnknownPropertyException
+ -- com::sun::star::beans::PropertyVetoException
+ -- com::sun::star::lang::IllegalArgumentException
+ -- com::sun::star::lang::WrappedTargetException
+ -- com::sun::star::uno::RuntimeException
@param nHandle
handle
diff --git a/cppuhelper/inc/cppuhelper/shlib.hxx b/cppuhelper/inc/cppuhelper/shlib.hxx
index 02ad8778..666359f 100644
--- a/cppuhelper/inc/cppuhelper/shlib.hxx
+++ b/cppuhelper/inc/cppuhelper/shlib.hxx
@@ -49,8 +49,8 @@ namespace cppu
@param xMgr service manager to be provided to the component
@param xKey registry key to be provided to the component
@return
- factory instance (::com::sun::star::lang::XSingleComponentFactory or
- ::com::sun::star::lang::XSingleComponentFactory)
+ factory instance (com::sun::star::lang::XSingleComponentFactory or
+ com::sun::star::lang::XSingleComponentFactory)
*/
CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
SAL_CALL loadSharedLibComponentFactory(
@@ -74,8 +74,8 @@ SAL_CALL loadSharedLibComponentFactory(
@param xKey registry key to be provided to the component
@param rPrefix optional component prefix
@return
- factory instance (::com::sun::star::lang::XSingleComponentFactory or
- ::com::sun::star::lang::XSingleComponentFactory)
+ factory instance (com::sun::star::lang::XSingleComponentFactory or
+ com::sun::star::lang::XSingleComponentFactory)
*/
CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
SAL_CALL loadSharedLibComponentFactory(
@@ -94,8 +94,8 @@ SAL_CALL loadSharedLibComponentFactory(
@param xKey registry key to be provided to the component
@param rPrefix optional component prefix
@return
- factory instance (::com::sun::star::lang::XSingleComponentFactory or
- ::com::sun::star::lang::XSingleComponentFactory)
+ factory instance (com::sun::star::lang::XSingleComponentFactory or
+ com::sun::star::lang::XSingleComponentFactory)
*/
CPPUHELPER_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
SAL_CALL invokeStaticComponentFactory(
@@ -112,7 +112,7 @@ SAL_CALL invokeStaticComponentFactory(
directory. The resulting path of the library will be checked against environment variable
CPLD_ACCESSPATH if set.
- @obsolete component_writeInfo should no longer be used in new components
+ @deprecated component_writeInfo should no longer be used in new components
@param rLibName name of the library
@param rPath optional path
diff --git a/cppuhelper/inc/cppuhelper/weak.hxx b/cppuhelper/inc/cppuhelper/weak.hxx
index c4cd733..80d5ec0 100644
--- a/cppuhelper/inc/cppuhelper/weak.hxx
+++ b/cppuhelper/inc/cppuhelper/weak.hxx
@@ -54,7 +54,7 @@ protected:
virtual ~OWeakObject() SAL_THROW( (::com::sun::star::uno::RuntimeException) );
/** disposes and resets m_pWeakConnectionPoint
- @precond
+ @pre
m_refCount equals 0
*/
void disposeWeakConnectionPoint();
diff --git a/cppuhelper/inc/cppuhelper/weakref.hxx b/cppuhelper/inc/cppuhelper/weakref.hxx
index 3b20e4a..0a95306 100644
--- a/cppuhelper/inc/cppuhelper/weakref.hxx
+++ b/cppuhelper/inc/cppuhelper/weakref.hxx
@@ -35,7 +35,7 @@ namespace uno
class OWeakRefListener;
/** The WeakReferenceHelper holds a weak reference to an object. This object must implement
- the ::com::sun::star::uno::XWeak interface. The implementation is thread safe.
+ the com::sun::star::uno::XWeak interface. The implementation is thread safe.
*/
class CPPUHELPER_DLLPUBLIC WeakReferenceHelper
{
@@ -111,7 +111,7 @@ protected:
};
/** The WeakReference<> holds a weak reference to an object. This object must implement
- the ::com::sun::star::uno::XWeak interface. The implementation is thread safe.
+ the com::sun::star::uno::XWeak interface. The implementation is thread safe.
@tparam interface_type type of interface
*/
diff --git a/framework/inc/services/sessionlistener.hxx b/framework/inc/services/sessionlistener.hxx
index c30ae9d..c8024b6 100644
--- a/framework/inc/services/sessionlistener.hxx
+++ b/framework/inc/services/sessionlistener.hxx
@@ -66,7 +66,6 @@ namespace framework{
if flush failed</li>
</ul>
*/
-/// @NOHTML
class SessionListener : // interfaces
public css::lang::XTypeProvider,
diff --git a/odk/CustomTarget_doxygen.mk b/odk/CustomTarget_doxygen.mk
index 626d055..2aa3832 100644
--- a/odk/CustomTarget_doxygen.mk
+++ b/odk/CustomTarget_doxygen.mk
@@ -28,13 +28,16 @@ odk_INCFILELIST := com/sun/star/uno/Any.h \
com/sun/star/uno/Type.hxx
# Cygwin Doxygen needs unix paths
-DOXY_INPUT := $(SRCDIR)/odk/pack/gendocu/main.dox $(addprefix $(OUTDIR)/inc/,$(odk_INCDIRLIST) $(odk_INCFILELIST))
+DOXY_INPUT := $(SRCDIR)/odk/pack/gendocu/main.dox $(SRCDIR)/sal/inc/sal/log-areas.dox \
+ $(addprefix $(OUTDIR)/inc/,$(odk_INCDIRLIST) $(odk_INCFILELIST))
DOXY_INPUT := $(if $(filter WNT,$(OS)),$(shell cygpath -u $(DOXY_INPUT)),$(DOXY_INPUT))
DOXY_WORKDIR := $(if $(filter WNT,$(OS)),$(shell cygpath -u $(odk_WORKDIR)/docs/cpp/ref),$(odk_WORKDIR)/docs/cpp/ref)
DOXY_STRIP_PATH := $(if $(filter WNT,$(OS)),$(shell cygpath -u $(OUTDIR)/inc),$(OUTDIR)/inc)
DOXY_DEPS := $(SRCDIR)/odk/pack/gendocu/Doxyfile \
$(SRCDIR)/odk/pack/gendocu/main.dox \
+ $(SRCDIR)/sal/inc/sal/log-areas.dox \
$(call gb_Package_get_target,sal_odk_headers) \
+ $(call gb_Package_get_target,sal_generated) \
$(call gb_Package_get_target,salhelper_odk_headers) \
$(call gb_Package_get_target,cppu_odk_headers) \
$(call gb_Package_get_target,cppuhelper_odk_headers) \
@@ -52,6 +55,6 @@ $(odk_WORKDIR)/docs/cpp/ref/index.html: $(DOXY_DEPS)
-e 's!^QUIET = %$$!QUIET = $(if $(VERBOSE),NO,YES)!' \
-e 's!^STRIP_FROM_PATH = %$$!STRIP_FROM_PATH = $(DOXY_STRIP_PATH)!' \
$< > $(odk_WORKDIR)/Doxyfile
- $(DOXYGEN) $(odk_WORKDIR)/Doxyfile > /dev/null
+ $(DOXYGEN) $(odk_WORKDIR)/Doxyfile > $(odk_WORKDIR)/doxygen.log
# vim: set noet sw=4 ts=4:
diff --git a/registry/inc/registry/registry.h b/registry/inc/registry/registry.h
index 25cad4a..030e1a1 100644
--- a/registry/inc/registry/registry.h
+++ b/registry/inc/registry/registry.h
@@ -140,11 +140,13 @@ REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setValue(RegKeyHandle hKey,
/** This function sets an long list value of a key.
- @param keyName points to a null terminated string specifying the name of a key which value
+ @param[in] hKey identifies a currently open key. The key which value will be set by this
+ function is a subkey of the key identified by hKey.
+ @param[in] keyName points to a null terminated string specifying the name of a key which value
will be set. If keyName is NULL, then the value of the key specified by
hKey will be set.
- @param pValueList points to an array of longs containing the data of the value.
- @param len specifies the len of pValueList.
+ @param[out] pValueList points to an array of longs containing the data of the value.
+ @param[out] len specifies the len of pValueList.
@return REG_NO_ERROR if succeeds else an error code.
*/
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setLongListValue(RegKeyHandle hKey,
@@ -155,11 +157,13 @@ REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setLongListValue(RegKeyHandle hKey,
/** This function sets an ascii list value of a key.
- @param keyName points to a null terminated string specifying the name of a key which value
+ @param[in] hKey identifies a currently open key. The key which value will be set by this
+ function is a subkey of the key identified by hKey.
+ @param[in] keyName points to a null terminated string specifying the name of a key which value
will be set. If keyName is NULL, then the value of the key specified by
hKey will be set.
- @param pValueList points to an array of sal_Char* containing the data of the value.
- @param len specifies the len of pValueList.
+ @param[in] pValueList points to an array of sal_Char* containing the data of the value.
+ @param[in] len specifies the len of pValueList.
@return REG_NO_ERROR if succeeds else an error code.
*/
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setStringListValue(RegKeyHandle hKey,
@@ -170,11 +174,13 @@ REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setStringListValue(RegKeyHandle hKe
/** This function sets an unicode string list value of a key.
- @param keyName points to a null terminated string specifying the name of a key which value
+ @param[in] hKey identifies a currently open key. The key which value will be set by this
+ function is a subkey of the key identified by hKey.
+ @param[in] keyName points to a null terminated string specifying the name of a key which value
will be set. If keyName is NULL, then the value of the key specified by
hKey will be set.
- @param pValueList points to an array of sal_Unicode* containing the data of the value.
- @param len specifies the len of pValueList.
+ @param[in] pValueList points to an array of sal_Unicode* containing the data of the value.
+ @param[in] len specifies the len of pValueList.
@return REG_NO_ERROR if succeeds else an error code.
*/
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_setUnicodeListValue(RegKeyHandle hKey,
@@ -217,11 +223,13 @@ REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getValue(RegKeyHandle hKey,
/** This function gets the long list value of a key.
- @param keyName points to a null terminated string specifying the name of a key which value
+ @param[in] hKey identifies a currently open key. The key which value will be got by this
+ function is a subkey of the key identified by hKey.
+ @param[in] keyName points to a null terminated string specifying the name of a key which value
will be got. If keyName is NULL, then the value of the key specified by
hKey will be got.
- @param pValueList a Pointer to a long value list which returns the data of the value.
- @param pLen returns the length of the value list.
+ @param[out] pValueList a Pointer to a long value list which returns the data of the value.
+ @param[out] pLen returns the length of the value list.
@return REG_NO_ERROR if succeeds else an error code.
*/
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getLongListValue(RegKeyHandle hKey,
@@ -232,11 +240,13 @@ REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getLongListValue(RegKeyHandle hKey,
/** This function gets the string list value of a key.
- @param keyName points to a null terminated string specifying the name of a key which value
- will be got. If keyName is NULL, then the value of the key specified by
- hKey will be got.
- @param pValueList a Pointer to an ascii value list which returns the data of the value.
- @param pLen returns the length of the value list.
+ @param[in] hKey identifies a currently open key. The key whose value will be retrived by this
+ function is a subkey of the key identified by hKey.
+ @param[in] keyName points to a null terminated string specifying the name of a key whose value
+ will be retrived. If keyName is NULL, then the value of the key specified by
+ hKey will be retrived.
+ @param[out] pValueList a Pointer to an ascii value list which returns the data of the value.
+ @param[out] pLen returns the length of the value list.
@return REG_NO_ERROR if succeeds else an error code.
*/
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getStringListValue(RegKeyHandle hKey,
@@ -247,11 +257,13 @@ REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getStringListValue(RegKeyHandle hKe
/** This function gets the unicode list value of a key.
- @param keyName points to a null terminated string specifying the name of a key which value
- will be got. If keyName is NULL, then the value of the key specified by
- hKey will be got.
- @param pValueList a Pointer to an unicode value list which returns the data of the value.
- @param pLen returns the length of the value list.
+ @param[in] hKey identifies a currently open key. The key whose value will be retrived by this
+ function is a subkey of the key identified by hKey.
+ @param[in] keyName points to a null terminated string specifying the name of a key whose value
+ will be retrived. If keyName is NULL, then the value of the key specified by
+ hKey will be retrived.
+ @param[out] pValueList a Pointer to an unicode value list which returns the data of the value.
+ @param[out] pLen returns the length of the value list.
@return REG_NO_ERROR if succeeds else an error code.
*/
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getUnicodeListValue(RegKeyHandle hKey,
@@ -276,9 +288,11 @@ REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_freeValueList(RegValueType valueTyp
The registry differentiates two possible types:
- RG_KEYTYPE represents a real key
- RG_LINKTYPE used to represent a link (no longer used)
- @param keyName points to a null terminated string specifying the name of the key which keytype
+ @param[in] hKey identifies a currently open key. The key specified by keyName is a subkey
+ of the key identified by hKey.
+ @param[in] keyName points to a null terminated string specifying the name of the key which keytype
will be returned.
- @param pKeyType returns the type of the key.
+ @param[out] pKeyType returns the type of the key.
@return REG_NO_ERROR if succeeds else an error code.
*/
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getKeyType(RegKeyHandle hKey,
@@ -287,12 +301,12 @@ REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getKeyType(RegKeyHandle hKey,
/** This function resolves a keyname.
- and returns the resolved keyName in pResolvedName.
- @param hKey identifies a currently open key. The key specified by keyName is a subkey
+ @param[in] hKey identifies a currently open key. The key specified by keyName is a subkey
of the key identified by hKey.
- @param keyName points to a null terminated string specifying the relativ name of a key.
+ @param[in] keyName points to a null terminated string specifying the relativ name of a key.
The name of hKey together with keyName will be generated.
- @param firstLinkOnly ignored
+ @param[in] firstLinkOnly ignored
+ @param[out] pResolvedName returns the resolved keyName.
@return REG_NO_ERROR if succeeds else an error code.
*/
REG_DLLPUBLIC RegError REGISTRY_CALLTYPE reg_getResolvedKeyName(RegKeyHandle hKey,
diff --git a/registry/inc/registry/registry.hxx b/registry/inc/registry/registry.hxx
index 3525508..239a916 100644
--- a/registry/inc/registry/registry.hxx
+++ b/registry/inc/registry/registry.hxx
@@ -627,9 +627,10 @@ public:
/** resolves a keyname.
- @param keyName specifies the name of the key which will be resolved relativ to this key.
+ @param[in] keyName specifies the name of the key which will be resolved relative to this key.
The resolved name will be prefixed with the name of this key.
- @param firstLinkOnly ignored
+ @param[in] firstLinkOnly ignored
+ @param[out] rResolvedName the resolved name.
@return REG_NO_ERROR if succeeds else an error code.
*/
inline RegError getResolvedKeyName(const ::rtl::OUString& keyName,
diff --git a/sal/inc/osl/file.hxx b/sal/inc/osl/file.hxx
index e2e304f..ee52cd5 100644
--- a/sal/inc/osl/file.hxx
+++ b/sal/inc/osl/file.hxx
@@ -282,7 +282,6 @@ public:
If pustrTempFileURL is not 0 the caller receives the name of the
created file and is responsible for removing the file.
- @descr
Description of the different pHandle, ppustrTempFileURL parameter combinations.
pHandle is 0 and pustrTempDirURL is 0 - this combination is invalid<br>
pHandle is not 0 and pustrTempDirURL is 0 - a handle to the open file
@@ -1256,7 +1255,6 @@ public:
<dd>On success</dd>
<dt>E_INVAL</dt>
<dd>The value of the input parameter is invalid</dd>
- </dl>
<br><p><strong>In addition to these error codes others may occur as well, for instance:</strong></p><br>
<dt>E_BADF</dt>
<dd>The file is not open for writing</dd>
diff --git a/sal/inc/osl/mutex.hxx b/sal/inc/osl/mutex.hxx
index 9ed6861..18ff444 100644
--- a/sal/inc/osl/mutex.hxx
+++ b/sal/inc/osl/mutex.hxx
@@ -34,7 +34,7 @@ namespace osl
public:
/** Create a thread-local mutex.
@return 0 if the mutex could not be created, otherwise a handle to the mutex.
- @seealso ::osl_createMutex()
+ @see ::osl_createMutex()
*/
Mutex()
{
@@ -42,7 +42,7 @@ namespace osl
}
/** Release the OS-structures and free mutex data-structure.
- @seealso ::osl_destroyMutex()
+ @see ::osl_destroyMutex()
*/
~Mutex()
{
@@ -51,7 +51,7 @@ namespace osl
/** Acquire the mutex, block if already acquired by another thread.
@return sal_False if system-call fails.
- @seealso ::osl_acquireMutex()
+ @see ::osl_acquireMutex()
*/
sal_Bool acquire()
{
@@ -60,7 +60,7 @@ namespace osl
/** Try to acquire the mutex without blocking.
@return sal_False if it could not be acquired.
- @seealso ::osl_tryToAcquireMutex()
+ @see ::osl_tryToAcquireMutex()
*/
sal_Bool tryToAcquire()
{
@@ -69,7 +69,7 @@ namespace osl
/** Release the mutex.
@return sal_False if system-call fails.
- @seealso ::osl_releaseMutex()
+ @see ::osl_releaseMutex()
*/
sal_Bool release()
{
@@ -80,7 +80,7 @@ namespace osl
The global and static mutex object can be used to initialize other
static objects in a thread safe manner.
@return the global mutex object
- @seealso ::osl_getGlobalMutex()
+ @see ::osl_getGlobalMutex()
*/
static Mutex * getGlobalMutex()
{
diff --git a/sal/inc/osl/security_decl.hxx b/sal/inc/osl/security_decl.hxx
index 0ac9276..5b8b170 100644
--- a/sal/inc/osl/security_decl.hxx
+++ b/sal/inc/osl/security_decl.hxx
@@ -51,12 +51,16 @@ public:
inline sal_Bool SAL_CALL logonUser(const rtl::OUString& strName,
const rtl::OUString& strPasswd);
/** get the security information for one user.
+
+ @verbatim
This method will try to login the user at the denoted file server.
If a network resource named \\server\username exists and this resource
could be connected by this user, the methos will return true and getHomeDir
will return \\server\username.
+ @endverbatim
@param[in] strName denotes the name of the user
@param[in] strPasswd denotes the password of this user
+ @param[in] strFileServer denotes the file server to login to
@return True, if the specified user is known by file server and the
could be connected, otherwise False
*/
diff --git a/sal/inc/osl/socket.h b/sal/inc/osl/socket.h
index 385c4c3c..ce47c86 100644
--- a/sal/inc/osl/socket.h
+++ b/sal/inc/osl/socket.h
@@ -283,6 +283,7 @@ SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_getInetPortOfSocketAddr(
/** Sets the Port of Addr.
+ @param[in] Addr the SocketAddr to perfom the operation on.
@param[in] Port is expected in host byte-order.
@return <code>sal_False</code> if Addr is not an inet-addr.
*/
@@ -291,7 +292,8 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setInetPortOfSocketAddr(
/** Returns the hostname represented by Addr.
- @param strHostname out-parameter. The hostname represented by the address. If
+ @param[in] Addr The socket address from which to extract the hostname.
+ @param[out] strHostname The hostname represented by the address. If
there is no hostname to be found, it returns 0.
*/
SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getHostnameOfSocketAddr(
@@ -299,7 +301,8 @@ SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_getHostnameOfSocketAddr(
/** Gets the address in dotted decimal format.
- @param strDottedInetAddr out-parameter. Contains the dotted decimal address
+ @param[in] Addr The socket address from which to extract the dotted decimal address.
+ @param[out] strDottedInetAddr Contains the dotted decimal address
(e.g. 141.99.20.34) represented by the address.
If the address is invalid or not of type <code>osl_Socket_FamilyInet</code>,
it returns 0.
@@ -314,7 +317,8 @@ SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_setAddrOfSocketAddr(
oslSocketAddr Addr, sal_Sequence *pByteSeq );
/** Returns the addr field in the struct sockaddr.
- @param ppByteSeq out parameter. After the call, *ppByteSeq contains the ipadrress
+ @param[in] Addr The socket address from which to extract the ipaddress.
+ @param[out] ppByteSeq After the call, *ppByteSeq contains the ipaddress
in network byteorder. *ppByteSeq may be 0 in case of an invalid socket handle.
@return <code>osl_Socket_Ok</code> or <code>osl_Socket_Error</code>
*/
@@ -466,6 +470,7 @@ SAL_DLLPUBLIC oslSocketResult SAL_CALL osl_connectSocketTo(
/** Prepares the socket to act as an acceptor of incoming connections.
You should call "listen" before you use "accept".
+ @param[in] Socket The socket to listen on.
@param[in] MaxPendingConnections denotes the length of the queue of
pending connections for this socket. If MaxPendingConnections is
-1, the systems default value will be used (Usually 5).
@@ -478,6 +483,7 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_listenOnSocket(
/** Waits for an ingoing connection on the socket.
This call blocks if there is no incoming connection present.
+ @param[in] Socket The socket to accept the connection on.
@param[in] pAddr if pAddr is != 0, the peers address is returned.
@return 0 if the accept-call failed, otherwise you get a socket
representing the new connection.
@@ -637,7 +643,8 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isExceptionPending(
oslSocket Socket, const TimeValue* pTimeout);
/** Shuts down communication on a connected socket.
- @param Direction denotes which end of the socket
+ @param[in] Socket the Socket to perfom the operation on.
+ @param[in] Direction denotes which end of the socket
should be closed:
<ul>
<li> <code>osl_Socket_DirRead</code> closes read operations.
@@ -784,6 +791,7 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isNonBlockingMode(
/** Queries the socket for its type.
+ @param[in] Socket The socket to query.
@return one of:
<ul>
<li> osl_Socket_TypeStream
@@ -793,13 +801,13 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isNonBlockingMode(
<li> osl_Socket_TypeSeqPacket
<li> osl_invalid_SocketType, if an error occurred
</ul>
-
*/
SAL_DLLPUBLIC oslSocketType SAL_CALL osl_getSocketType(
oslSocket Socket);
/** returns a string which describes the last socket error.
- @param strError out-parameter. The string that receives the error message.
+ @param[in] Socket The socket to query.
+ @param[out] strError The string that receives the error message.
*/
SAL_DLLPUBLIC void SAL_CALL osl_getLastSocketErrorDescription(
oslSocket Socket, rtl_uString **strError);
@@ -871,14 +879,16 @@ SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_demultiplexSocketEvents(oslSocketSet Incomi
const TimeValue* pTimeout);
/** Closes the socket terminating any ongoing dataflow.
+ @param[in] Socket The socket to close.
*/
SAL_DLLPUBLIC void SAL_CALL osl_closeSocket(oslSocket Socket);
/** Retrieves n bytes from the stream and copies them into pBuffer.
The function avoids incomplete reads due to packet boundaries.
- @param pBuffer receives the read data.
- @param nSize the number of bytes to read. pBuffer must be large enough
+ @param[in] Socket The socket to read from.
+ @param[out] pBuffer receives the read data.
+ @param[out] nSize the number of bytes to read. pBuffer must be large enough
to hold the n bytes!
@return the number of read bytes. The number will only be smaller than
n if an exceptional condition (e.g. connection closed) occurs.
@@ -888,8 +898,9 @@ SAL_DLLPUBLIC sal_Int32 SAL_CALL osl_readSocket( oslSocket Socket, void *pBuffer
/** Writes n bytes from pBuffer to the stream. The method avoids
incomplete writes due to packet boundaries.
- @param pBuffer contains the data to be written.
- @param nSize the number of bytes to write.
+ @param[out] Socket The socket to write to.
+ @param[in] pBuffer contains the data to be written.
+ @param[in] nSize the number of bytes to write.
@return the number of written bytes. The number will only be smaller than
nSize if an exceptional condition (e.g. connection closed) occurs.
*/
diff --git a/sal/inc/osl/socket_decl.hxx b/sal/inc/osl/socket_decl.hxx
index 2b45b97..822450d 100644
--- a/sal/inc/osl/socket_decl.hxx
+++ b/sal/inc/osl/socket_decl.hxx
@@ -48,7 +48,6 @@ namespace osl
/** The SocketAddr takes over the responsibility of the handle ( which means,
that the handle gets destructed by the destructor of this reference)
-
@param nocopy use SAL_NO_COPY
*/
inline SocketAddr(const oslSocketAddr , __osl_socket_NoCopy nocopy );
@@ -116,6 +115,7 @@ namespace osl
inline SocketAddr & SAL_CALL operator= (const SocketAddr& Addr);
/** Assigns the socket addr without copyconstructing it.
+ @param Addr the socket address.
@param nocopy use SAL_NO_COPY
*/
inline SocketAddr & SAL_CALL assign( oslSocketAddr Addr, __osl_socket_NoCopy nocopy );
@@ -180,6 +180,7 @@ namespace osl
/** The instance takes over the handle's ownership without acquiring the
handle, but releases it within the dtor.
+ @param socketHandle the handle
@param noacquire use SAL_NO_ACQUIRE
*/
inline Socket( oslSocket socketHandle, __sal_NoAcquire noacquire );
@@ -498,6 +499,8 @@ namespace osl
{
public:
/** Creates a socket.
+ @param Family the Family of the socket (Inet by default)
+ @param Protocol the Protocon of the socket (IP by default)
@param Type For some protocols it might be desirable to
use a different type than <code>osl_Socket_TypeStream</code>
(like <code>osl_Socket_TypeSeqPacket</code>).
@@ -579,6 +582,8 @@ namespace osl
{
public:
/** Creates a socket that can connect to a (remote) host.
+ @param Family the Family of the socket (Inet by default)
+ @param Protocol the Protocon of the socket (IP by default)
@param Type For some protocols it might be desirable to
use a different type than sock_stream <code>osl_Socket_TypeSeqPacket</code>
(like <code>osl_Socket_TypeSeqPacket</code>).
@@ -649,6 +654,8 @@ namespace osl
public:
/** Creates a datagram socket.
+ @param Family the Family of the socket (Inet by default)
+ @param Protocol the Protocon of the socket (IP by default)
@param Type is sock_dgram by default.
*/
inline DatagramSocket(oslAddrFamily Family= osl_Socket_FamilyInet,
diff --git a/sal/inc/rtl/alloc.h b/sal/inc/rtl/alloc.h
index de708ea..ef48d01 100644
--- a/sal/inc/rtl/alloc.h
+++ b/sal/inc/rtl/alloc.h
@@ -31,7 +31,8 @@ extern "C" {
/** Allocate memory.
- @descr A call to this function will return NULL upon the requested
+
+ A call to this function will return NULL upon the requested
memory size being either zero or larger than currently allocatable.
@param Bytes [in] memory size.
@@ -43,9 +44,9 @@ SAL_DLLPUBLIC void * SAL_CALL rtl_allocateMemory (
/** Reallocate memory.
- @descr A call to this function with parameter 'Ptr' being NULL
- is equivalent to a rtl_allocateMemory() call.
+ A call to this function with parameter 'Ptr' being NULL
+ is equivalent to a rtl_allocateMemory() call.
A call to this function with parameter 'Bytes' being 0
is equivalent to a rtl_freeMemory() call.
@@ -72,7 +73,8 @@ SAL_DLLPUBLIC void SAL_CALL rtl_freeMemory (
/** Allocate and zero memory.
- @descr A call to this function will return NULL upon the requested
+
+ A call to this function will return NULL upon the requested
memory size being either zero or larger than currently allocatable.
@param Bytes [in] memory size.
@@ -187,6 +189,7 @@ typedef struct rtl_cache_st rtl_cache_type;
* @param destructor [in] object destructor callback function.
* @param reclaim [in] reclaim callback function.
* @param pUserArg [in] opaque argument passed to callback functions.
+ * @param pSource [in] opaque argument passed to callback functions.
* @param nFlags [in] flags.
*
* @return pointer to rtl_cache_type, or NULL upon failure.
diff --git a/sal/inc/rtl/bootstrap.h b/sal/inc/rtl/bootstrap.h
index 76795ba..67fed2d 100644
--- a/sal/inc/rtl/bootstrap.h
+++ b/sal/inc/rtl/bootstrap.h
@@ -106,6 +106,7 @@ extern "C" {
is different than the executable file name. It must be given on command line. If it is
given the executable ini-file is ignored.
</li>
+ </ul>
*/
/** may be called by an application to set an ini-filename.
@@ -115,7 +116,7 @@ extern "C" {
If it is never called, the filename is based on the name of the executable,
with the suffix ".ini" on Windows or "rc" on Unix.
- @param pNameUri URL of the inifile with path but WITHOUT suffix (.ini or rc)
+ @param pFileUri URL of the inifile with path but WITHOUT suffix (.ini or rc)
*/
SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_setIniFileName( rtl_uString *pFileUri )
SAL_THROW_EXTERN_C();
@@ -186,7 +187,8 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL rtl_bootstrap_get_from_handle(
/** Returns the name of the inifile associated with this handle.
- @param ppIniName contains after the call the name of the ini-filename.
+ @param handle [in] The handle got by <code>rtl_bootstrap_args_open()</code>
+ @param ppIniName [out] contains after the call the name of the ini-filename.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_bootstrap_get_iniName_from_handle(
rtlBootstrapHandle handle, rtl_uString ** ppIniName)
diff --git a/sal/inc/rtl/cipher.h b/sal/inc/rtl/cipher.h
index be90d12..a116e57 100644
--- a/sal/inc/rtl/cipher.h
+++ b/sal/inc/rtl/cipher.h
@@ -143,7 +143,7 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_init (
/** Encode a buffer under a given cipher algorithm.
- @precond Initialized for a compatible cipher direction.
+ @pre Initialized for a compatible cipher direction.
@see rtl_cipher_init()
@param Cipher [in] cipher handle.
@@ -161,7 +161,7 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_encode (
/** Decode a buffer under a given cipher algorithm.
- @precond Initialized for a compatible cipher direction.
+ @pre Initialized for a compatible cipher direction.
@see rtl_cipher_init()
@param Cipher [in] cipher handle.
@@ -193,7 +193,8 @@ SAL_DLLPUBLIC void SAL_CALL rtl_cipher_destroy (
*
*======================================================================*/
/** Create a Blowfish cipher handle for the given mode.
- @descr The Blowfish block cipher algorithm is specified in
+
+ The Blowfish block cipher algorithm is specified in
Bruce Schneier: Applied Cryptography, 2nd edition, ch. 14.3
@see rtl_cipher_create()
@@ -248,7 +249,8 @@ SAL_DLLPUBLIC void SAL_CALL rtl_cipher_destroyBF (
*
*======================================================================*/
/** Create a RC4 cipher handle for the given mode.
- @descr The RC4 symmetric stream cipher algorithm is specified in
+
+ The RC4 symmetric stream cipher algorithm is specified in
Bruce Schneier: Applied Cryptography, 2nd edition, ch. 17.1
@see rtl_cipher_create()
diff --git a/sal/inc/rtl/crc.h b/sal/inc/rtl/crc.h
index aafd9cb..7fad87e 100644
--- a/sal/inc/rtl/crc.h
+++ b/sal/inc/rtl/crc.h
@@ -35,7 +35,8 @@ extern "C" {
*
*======================================================================*/
/** Evaluate CRC32 over given data.
- @descr This function evaluates the CRC polynomial 0xEDB88320.
+
+ This function evaluates the CRC polynomial 0xEDB88320.
@param Crc [in] CRC32 over previous data or zero.
@param Data [in] data buffer.
diff --git a/sal/inc/rtl/digest.h b/sal/inc/rtl/digest.h
index 7c01335..cc49838 100644
--- a/sal/inc/rtl/digest.h
+++ b/sal/inc/rtl/digest.h
@@ -91,7 +91,7 @@ SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_create (
/** Destroy a digest handle.
- @postcond Digest handle destroyed and invalid.
+ @post Digest handle destroyed and invalid.
@param Digest [in] digest handle to be destroyed.
@return None.
*/
@@ -145,8 +145,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_update (
/** Finalize a digest and retrieve the digest value.
- @precond Digest value length must not be less than digest length.
- @postcond Digest initialized to accept another update sequence.
+ @pre Digest value length must not be less than digest length.
+ @post Digest initialized to accept another update sequence.
@see rtl_digest_queryLength()
@see rtl_digest_update()
@@ -169,8 +169,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_get (
#define RTL_DIGEST_LENGTH_MD2 16
/** Create a MD2 digest handle.
- @descr The MD2 digest algorithm is specified in
+ The MD2 digest algorithm is specified in
RFC 1319 (Informational)
The MD2 Message-Digest Algorithm
@@ -206,7 +206,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getMD2 (
/** Evaluate a MD2 digest value from given data.
- @descr This function performs an optimized call sequence on a
+
+ This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_updateMD2()
@@ -232,8 +233,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD2 (
#define RTL_DIGEST_LENGTH_MD5 16
/** Create a MD5 digest handle.
- @descr The MD5 digest algorithm is specified in
+ The MD5 digest algorithm is specified in
RFC 1321 (Informational)
The MD5 Message-Digest Algorithm
@@ -269,10 +270,11 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getMD5 (
/** Retrieve the raw (not finalized) MD5 digest value.
- @descr This function is a non-standard replacement for
+
+ This function is a non-standard replacement for
rtl_digest_getMD5() and must be used with caution.
- @postcond Digest initialized to accept another update sequence.
+ @post Digest initialized to accept another update sequence.
@see rtl_digest_get()
*/
SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_rawMD5 (
@@ -282,7 +284,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_rawMD5 (
/** Evaluate a MD5 digest value from given data.
- @descr This function performs an optimized call sequence on a
+
+ This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_updateMD5()
@@ -308,8 +311,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD5 (
#define RTL_DIGEST_LENGTH_SHA 20
/** Create a SHA digest handle.
- @descr The SHA digest algorithm is specified in
+ The SHA digest algorithm is specified in
FIPS PUB 180 (Superseded by FIPS PUB 180-1)
Secure Hash Standard
@@ -345,7 +348,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA (
/** Evaluate a SHA digest value from given data.
- @descr This function performs an optimized call sequence on a
+
+ This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_updateSHA()
@@ -371,8 +375,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA (
#define RTL_DIGEST_LENGTH_SHA1 20
/** Create a SHA1 digest handle.
- @descr The SHA1 digest algorithm is specified in
+ The SHA1 digest algorithm is specified in
FIPS PUB 180-1 (Supersedes FIPS PUB 180)
Secure Hash Standard
@@ -408,7 +412,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA1 (
/** Evaluate a SHA1 digest value from given data.
- @descr This function performs an optimized call sequence on a
+
+ This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_updateSHA1()
@@ -434,7 +439,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA1 (
#define RTL_DIGEST_LENGTH_HMAC_MD5 RTL_DIGEST_LENGTH_MD5
/** Create a HMAC_MD5 digest handle.
- @descr The HMAC_MD5 digest algorithm is specified in
+
+ The HMAC_MD5 digest algorithm is specified in
RFC 2104 (Informational)
HMAC: Keyed-Hashing for Message Authentication
@@ -486,7 +492,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_MD5 (
/** Evaluate a HMAC_MD5 digest value from given data.
- @descr This function performs an optimized call sequence on a
+
+ This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_initHMAC_MD5()
@@ -516,8 +523,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_MD5 (
#define RTL_DIGEST_LENGTH_HMAC_SHA1 RTL_DIGEST_LENGTH_SHA1
/** Create a HMAC_SHA1 digest handle.
- @descr The HMAC_SHA1 digest algorithm is specified in
+ The HMAC_SHA1 digest algorithm is specified in
RFC 2104 (Informational)
HMAC: Keyed-Hashing for Message Authentication
RFC 2898 (Informational)
@@ -570,7 +577,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_SHA1 (
/** Evaluate a HMAC_SHA1 digest value from given data.
- @descr This function performs an optimized call sequence on a
+
+ This function performs an optimized call sequence on a
single data buffer, avoiding digest creation and destruction.
@see rtl_digest_initHMAC_SHA1()
@@ -598,8 +606,8 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_SHA1 (
*
*======================================================================*/
/** Password-Based Key Derivation Function.
- @descr The PBKDF2 key derivation function is specified in
+ The PBKDF2 key derivation function is specified in
RFC 2898 (Informational)
PKCS #5: Password-Based Cryptography Specification Version 2.0
diff --git a/sal/inc/rtl/logfile.hxx b/sal/inc/rtl/logfile.hxx
index 50083ca..5ee0739 100644
--- a/sal/inc/rtl/logfile.hxx
+++ b/sal/inc/rtl/logfile.hxx
@@ -25,7 +25,7 @@
namespace rtl
{
/**
- at descr The intended use for class Logfile is to write time stamp information
+ at brief The intended use for class Logfile is to write time stamp information
for profiling purposes.
Profiling output should only be generated for a special product version of OpenOffice
@@ -93,7 +93,9 @@ namespace rtl
{
public:
inline Logfile( const sal_Char *name );
- /** @descr Create a log file context where the message field consists of a project
+ /** Create a log file context
+
+ Create a log file context where the message field consists of a project
name, the author's shortcut, and the actual message. These three strings
are written in a format that is understood by script that later parses the
log file and that so can extract the three strings.
diff --git a/sal/inc/rtl/strbuf.h b/sal/inc/rtl/strbuf.h
index f966548..05dd2de 100644
--- a/sal/inc/rtl/strbuf.h
+++ b/sal/inc/rtl/strbuf.h
@@ -79,12 +79,13 @@ SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_stringbuffer_newFromStringBuffer(
If the <code>minimumCapacity</code> argument is nonpositive, this
method takes no action and simply returns.
- @param capacity in: old capicity, out: new capacity.
- @param minimumCapacity the minimum desired capacity.
+ @param[in,out] This the String to operate on.
+ @param[in,out] capacity in: old capacity, out: new capacity.
+ @param[in] minimumCapacity the minimum desired capacity.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_ensureCapacity(
- /*inout*/rtl_String ** This,
- /*inout*/sal_Int32* capacity,
+ rtl_String ** This,
+ sal_Int32* capacity,
sal_Int32 minimumCapacity);
@@ -97,14 +98,15 @@ SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_ensureCapacity(
<code>offset</code>. The length of this string buffer increases by
the length of the argument.
- @param capacity the capacity of the string buffer
- @param offset the offset.
- @param str a character array.
- @param len the number of characters to append.
+ @param[in,out] This the String to operate on.
+ @param[in,out] capacity the capacity of the string buffer
+ @param[in] offset the offset.
+ @param[in] str a character array.
+ @param[in] len the number of characters to append.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_insert(
- /*inout*/rtl_String ** This,
- /*inout*/sal_Int32 * capacity,
+ rtl_String ** This,
+ sal_Int32 * capacity,
sal_Int32 offset,
const sal_Char * str,
sal_Int32 len);
@@ -117,11 +119,12 @@ SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_insert(
start must be >= 0 && <= This->length
- @param start The beginning index, inclusive
- @param len The substring length
+ @param[in,out] This The String to operate on.
+ @param[in] start The beginning index, inclusive
+ @param[in] len The substring length
*/
SAL_DLLPUBLIC void SAL_CALL rtl_stringbuffer_remove(
- /*inout*/rtl_String ** This,
+ rtl_String ** This,
sal_Int32 start,
sal_Int32 len );
diff --git a/sal/inc/rtl/strbuf.hxx b/sal/inc/rtl/strbuf.hxx
index fe19227..b5d746e 100644
--- a/sal/inc/rtl/strbuf.hxx
+++ b/sal/inc/rtl/strbuf.hxx
@@ -567,6 +567,7 @@ public:
string are then appended to this string buffer.
@param i an <code>sal_Int32</code>.
+ @param radix the radix
@return this string buffer.
*/
OStringBuffer & append(sal_Int32 i, sal_Int16 radix = 10 )
@@ -584,6 +585,7 @@ public:
string are then appended to this string buffer.
@param l a <code>long</code>.
+ @param radix the radix
@return this string buffer.
*/
OStringBuffer & append(sal_Int64 l, sal_Int16 radix = 10 )
@@ -780,6 +782,7 @@ public:
@param offset the offset.
@param i an <code>sal_Int32</code>.
+ @param radix the radix
@return this string buffer.
*/
OStringBuffer & insert(sal_Int32 offset, sal_Int32 i, sal_Int16 radix = 10 )
@@ -803,6 +806,7 @@ public:
@param offset the offset.
@param l a <code>long</code>.
+ @param radix the radix
@return this string buffer.
*/
OStringBuffer & insert(sal_Int32 offset, sal_Int64 l, sal_Int16 radix = 10 )
diff --git a/sal/inc/rtl/string.h b/sal/inc/rtl/string.h
index 6fc83491..a16d61e 100644
--- a/sal/inc/rtl/string.h
+++ b/sal/inc/rtl/string.h
@@ -855,11 +855,8 @@ SAL_DLLPUBLIC void SAL_CALL rtl_string_new( rtl_String ** newStr ) SAL_THROW_EXT
alternatively pass ownership to an OUString with
rtl::OUString(newStr, SAL_NO_ACQUIRE);
- @param newStr
- pointer to the new string.
-
- @param len
- the number of characters.
+ @param[out] nLen the number of characters.
+ @return pointer to the new string.
@since LibreOffice 4.1
*/
@@ -936,9 +933,10 @@ SAL_DLLPUBLIC void SAL_CALL rtl_string_newFromStr_WithLength( rtl_String ** newS
or beginIndex + count greater than the length of the string have
undefined behaviour.
- @param beginIndex the beginning index, inclusive.
- @param count the number of characters.
- @return the specified substring.
+ @param[out] newStr the specified substring.
+ @param[in] from the String to take the substring from.
+ @param[in] beginIndex the beginning index, inclusive.
+ @param[in] count the number of characters.
@since LibreOffice 4.0
*/
diff --git a/sal/inc/rtl/uri.h b/sal/inc/rtl/uri.h
index 1e58e17..251af02 100644
--- a/sal/inc/rtl/uri.h
+++ b/sal/inc/rtl/uri.h
@@ -33,13 +33,11 @@ extern "C" {
/** Various predefined URI 'char classes.'
- @descr
A 'char class' defines which (ASCII) characters can be written 'as they
are' in a part of a Uri, and which characters have to be written using
escape sequences ('%' followed by two hex digits). Characters outside
the ASCII range are always written using escape sequences.
- @descr
If there are other frequently used char classes, they can be added to
this enumeration; the function rtl_getUriCharClass() has to be adapted
then, too.
@@ -48,58 +46,64 @@ typedef enum
{
/** The empty char class.
- @descr
All characters are written using escape sequences.
*/
rtl_UriCharClassNone,
/** The RFC 2732 @<uric> char class.
- @descr
+ @verbatim
The 'valid' characters are !$&'()*+,-./:;=?@[]_~ plus digits and
letters.
+ @endverbatim
*/
rtl_UriCharClassUric,
/** The RFC 2396 @<uric_no_slash> char class.
- @descr
+ @verbatim
The 'valid' characters are !$&'()*+,-.:;=?@_~ plus digits and letters.
+ @endverbatim
*/
rtl_UriCharClassUricNoSlash,
/** The RFC 2396 @<rel_segment> char class.
- @descr
+ @verbatim
The 'valid' characters are !$&'()*+,-.;=@_~ plus digits and letters.
+ @endverbatim
*/
rtl_UriCharClassRelSegment,
/** The RFC 2396 @<reg_name> char class.
- @descr
+ @verbatim
The 'valid' characters are !$&'()*+,-.:;=@_~ plus digits and letters.
+ @endverbatim
*/
rtl_UriCharClassRegName,
/** The RFC 2396 @<userinfo> char class.
- @descr
+ @verbatim
The 'valid' characters are !$&'()*+,-.:;=_~ plus digits and letters.
+ @endverbatim
*/
rtl_UriCharClassUserinfo,
/** The RFC 2396 @<pchar> char class.
- @descr
+ @verbatim
The 'valid' characters are !$&'()*+,-.:=@_~ plus digits and letters.
+ @endverbatim
*/
rtl_UriCharClassPchar,
/** The char class for the values of uno URL parameters.
- @descr
+ @verbatim
The 'valid' characters are !$&'()*+-./:?@_~ plus digits and letters.
+ @endverbatim
*/
rtl_UriCharClassUnoParamValue,
@@ -115,7 +119,6 @@ typedef enum
/** The special meaning of '%' is ignored (i.e., there are by definition
no escape sequences in the input).
- @descr
This mechanism is useful to encode user input as part of a URI (e.g.,
the user-supplied password in an ftp URL---'%20abcde' is a valid
password, so do not assume that the '%20' is an escaped space).
@@ -126,7 +129,6 @@ typedef enum
even if they represent characters that need not be escaped or if they
do not even map to characters in the given charset.
- @descr
This mechanism is useful when passing on complete URIs more or less
unmodified (e.g., within an HTTP proxy): missing escape sequences are
added, but existing escape sequences are not touched (except that any
@@ -138,7 +140,6 @@ typedef enum
a first step; only those that represent characters that need to be
escaped are kept intact.
- @descr
This mechanism is useful to properly encode complete URIs entered by
the user: the URI is brought into a 'canonic form,' but care is taken
not to damage (valid) escape sequences the (careful) user already
@@ -176,7 +177,6 @@ typedef enum
/** The text is returned in the form of an IURI (cf.
draft-masinter-url-i18n-05.txt).
- @descr
All escape sequences representing ASCII characters (%00--%7F) are
kept, all other escape sequences are interpreted as UTF-8 characters
and translated to Unicode, if possible.
@@ -185,7 +185,6 @@ typedef enum
/** The text is decoded.
- @descr
All escape sequences representing characters from the given charset
are decoded and translated to Unicode, if possible.
*/
@@ -204,7 +203,6 @@ rtl_UriDecodeMechanism;
/** Map a predefined rtl_UriCharClass to a form usable by rtl_uriEncode().
- @descr
The function rtl_uriEncode() expects an array of 128 booleans, and this
function maps rtl_UriCharClass enumeration members to such arrays.
diff --git a/sal/inc/rtl/ustrbuf.h b/sal/inc/rtl/ustrbuf.h
index f52fac4..7df10c1 100644
--- a/sal/inc/rtl/ustrbuf.h
+++ b/sal/inc/rtl/ustrbuf.h
@@ -79,12 +79,13 @@ SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_uStringbuffer_newFromStringBuffer(
If the <code>minimumCapacity</code> argument is nonpositive, this
method takes no action and simply returns.
- @param capacity in: old capicity, out: new capacity.
- @param minimumCapacity the minimum desired capacity.
+ @param[in,out] This the String to operate on.
+ @param[in,out] capacity in: old capacity, out: new capacity.
+ @param[in] minimumCapacity the minimum desired capacity.
*/
SAL_DLLPUBLIC void SAL_CALL rtl_uStringbuffer_ensureCapacity(
- /*inout*/rtl_uString ** This,
- /*inout*/sal_Int32* capacity,
+ rtl_uString ** This,
+ sal_Int32* capacity,
sal_Int32 minimumCapacity);
/**
@@ -165,11 +166,12 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uStringbuffer_insert_ascii(
start must be >= 0 && <= This->length
- @param start The beginning index, inclusive
- @param len The substring length
+ @param[in,out] This The String to operate on.
+ @param[in] start The beginning index, inclusive
+ @param[in] len The substring length
*/
SAL_DLLPUBLIC void SAL_CALL rtl_uStringbuffer_remove(
- /*inout*/rtl_uString ** This,
+ rtl_uString ** This,
sal_Int32 start,
sal_Int32 len );
diff --git a/sal/inc/rtl/ustrbuf.hxx b/sal/inc/rtl/ustrbuf.hxx
index 8e4ca1d..5743800 100644
--- a/sal/inc/rtl/ustrbuf.hxx
+++ b/sal/inc/rtl/ustrbuf.hxx
@@ -667,6 +667,7 @@ public:
string are then appended to this string buffer.
@param i an <code>sal_Int32</code>.
+ @param radix the radix
@return this string buffer.
*/
OUStringBuffer & append(sal_Int32 i, sal_Int16 radix = 10 )
@@ -684,6 +685,7 @@ public:
string are then appended to this string buffer.
@param l a <code>long</code>.
+ @param radix the radix
@return this string buffer.
*/
OUStringBuffer & append(sal_Int64 l, sal_Int16 radix = 10 )
diff --git a/sal/inc/rtl/ustring.h b/sal/inc/rtl/ustring.h
index ba19b83..f6bf956 100644
--- a/sal/inc/rtl/ustring.h
+++ b/sal/inc/rtl/ustring.h
@@ -1207,11 +1207,8 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_new(
alternatively pass ownership to an OUString with
rtl::OUString(newStr, SAL_NO_ACQUIRE);
- @param newStr
- pointer to the new string.
-
- @param len
- the number of characters.
+ @param[in] nLen the number of characters.
+ @return pointer to the new string.
@since LibreOffice 4.1
*/
@@ -1292,8 +1289,10 @@ SAL_DLLPUBLIC void SAL_CALL rtl_uString_newFromStr_WithLength(
or beginIndex + count greater than the length of the string have
undefined behaviour.
- @param beginIndex the beginning index, inclusive.
- @param count the number of characters.
+ @param[out] newStr the specified substring.
+ @param[in] from the String to take the substring from.
+ @param[in] beginIndex the beginning index, inclusive.
+ @param[in] count the number of characters.
@return the specified substring.
@since LibreOffice 4.0
diff --git a/sal/inc/sal/log.hxx b/sal/inc/sal/log.hxx
index 71e2d52..340589e 100644
--- a/sal/inc/sal/log.hxx
+++ b/sal/inc/sal/log.hxx
@@ -212,11 +212,15 @@ inline char const * unwrapStream(SAL_UNUSED_PARAMETER StreamIgnore const &) {
For all the other macros, the given area argument must be non-null and must
match the regular expression
+ @verbatim
<area> ::= <segment>("."<segment>)*
+ @endverbatim
with
+ @verbatim
<segment> ::= [0-9a-z]+
+ @endverbatim
For a list of areas used see @ref sal_log_areas "SAL debug areas". Whenever
you use a new log area, add it to the file sal/inc/sal/log-areas.dox .
@@ -233,13 +237,17 @@ inline char const * unwrapStream(SAL_UNUSED_PARAMETER StreamIgnore const &) {
macro calls actually generate log output. The environment variable SAL_LOG
must either be unset or must match the regular expression
+ @verbatim
<env> ::= <switch>*
+ @endverbatim
with
+ @verbatim
<switch> ::= <sense><level>("."<area>)?
<sense> ::= "+"|"-"
<level> ::= "INFO"|"WARN"
+ @endverbatim
If the environment variable is unset, "+WARN" is used instead (which results
in all warnings being output but no infos). If the given value does not
diff --git a/store/inc/store/store.h b/store/inc/store/store.h
index 7a180f1..ff3f1ef 100644
--- a/store/inc/store/store.h
+++ b/store/inc/store/store.h
@@ -323,8 +323,8 @@ STORE_DLLPUBLIC storeError SAL_CALL store_attrib (
/** Insert a file entry as 'hard link' to another file entry.
- @precond Source must not exist, Destination must exist.
- @postcond Source has attribute STORE_ATTRIB_ISLINK.
+ @pre Source must not exist, Destination must exist.
+ @post Source has attribute STORE_ATTRIB_ISLINK.
@see store_attrib()
@param hFile [in] the File Handle
@@ -342,8 +342,8 @@ STORE_DLLPUBLIC storeError SAL_CALL store_link (
/** Insert a file entry as 'symbolic link' to another file entry.
- @precond Source must not exist
- @postcond Source has attribute STORE_ATTRIB_ISLINK.
+ @pre Source must not exist
+ @post Source has attribute STORE_ATTRIB_ISLINK.
@see store_attrib()
@param hFile [in] the File Handle
commit b6b49c0f6bc797558b6ce08fa756efe474a8011b
Author: Peter Foley <pefoley2 at verizon.net>
Date: Sun Mar 17 14:35:22 2013 -0400
cleanup autodoc output
Change-Id: I5c25084c8a6e13416cea67c907de276b73c2e955
diff --git a/odk/CustomTarget_autodoc.mk b/odk/CustomTarget_autodoc.mk
index 7bb2bd8..cf87fcc 100644
--- a/odk/CustomTarget_autodoc.mk
+++ b/odk/CustomTarget_autodoc.mk
@@ -20,7 +20,8 @@ $(odk_WORKDIR)/docs/common/ref/module-ix.html: $(SRCDIR)/odk/pack/copying/idl_ch
$(call gb_Helper_execute,autodoc) -html $(dir $@) \
-dvgroot "http://wiki.services.openoffice.org/wiki" \
-name "LibreOffice $(PRODUCTVERSION) API" \
- -lg idl -dvgfile $< -t $(SRCDIR)/udkapi $(SRCDIR)/offapi
+ -lg idl -dvgfile $< -t $(SRCDIR)/udkapi $(SRCDIR)/offapi \
+ > $(odk_WORKDIR)/autodoc_log.txt
# vim: set noet sw=4 ts=4:
diff --git a/odk/pack/copying/idl_chapter_refs.txt b/odk/pack/copying/idl_chapter_refs.txt
index 6db8a9d..8569d28 100644
--- a/odk/pack/copying/idl_chapter_refs.txt
+++ b/odk/pack/copying/idl_chapter_refs.txt
@@ -392,7 +392,7 @@ DESCR:Text - Indexes and Index Marks - Indexes
REF:
com.sun.star.text.BibliographyDataType
com.sun.star.text.BibliographyDataField
-com.sun.star.text.IllustrationIndex
+com.sun.star.text.IllustrationsIndex
com.sun.star.beans.XPropertySet
com.sun.star.container.XIndexReplace
com.sun.star.text.Bibliography
@@ -3224,8 +3224,8 @@ com.sun.star.text.textfield.Bibliography
com.sun.star.text.textfield.Chapter
com.sun.star.text.textfield.Input
com.sun.star.text.textfield.SetExpression
-com.sun.star.text.FieldMaster.Database
-com.sun.star.text.FieldMaster.User
+com.sun.star.text.fieldmaster.Database
+com.sun.star.text.fieldmaster.User
com.sun.star.text.textfield.ReferencePageGet
com.sun.star.text.textfield.ParagraphCount
com.sun.star.text.textfield.Author
@@ -3247,15 +3247,15 @@ com.sun.star.text.textfield.DatabaseName
com.sun.star.util.XUpdatable
com.sun.star.text.TextContent
com.sun.star.text.textfield.DatabaseSetNumber
-com.sun.star.text.FieldMaster.SetExpression
+com.sun.star.text.fieldmaster.SetExpression
com.sun.star.text.textfield.ExtendedUser
-com.sun.star.text.FieldMaster.DDE
+com.sun.star.text.fieldmaster.DDE
com.sun.star.text.textfield.docinfo.CreateAuthor
com.sun.star.text.textfield.docinfo.Subject
com.sun.star.text.textfield.PageNumber
com.sun.star.text.textfield.TableFormula
com.sun.star.text.textfield.docinfo.Keywords
-com.sun.star.text.FieldMaster.Bibliography
+com.sun.star.text.fieldmaster.Bibliography
com.sun.star.text.textfield.GetReference
com.sun.star.text.textfield.WordCount
com.sun.star.text.textfield.DDE
@@ -3276,7 +3276,7 @@ com.sun.star.text.textfield.docinfo.Description
com.sun.star.text.textfield.DatabaseNextSet
com.sun.star.text.textfield.docinfo.PrintDateTime
TOPIC:
-com.sun.star.text.FieldMaster
+com.sun.star.text.fieldmaster
com.sun.star.text.TextField
com.sun.star.text.XTextField
diff --git a/offapi/com/sun/star/text/BaseIndex.idl b/offapi/com/sun/star/text/BaseIndex.idl
index cd42ebb..8478275 100644
--- a/offapi/com/sun/star/text/BaseIndex.idl
+++ b/offapi/com/sun/star/text/BaseIndex.idl
@@ -36,7 +36,7 @@
/** specifies the basic service of different indexes within a document. at see com::sun::star::text::DocumentIndex
@see com::sun::star::text::ContentIndex
@see com::sun::star::text::UserDefinedIndex
- @see com::sun::star::text::IllustrationIndex
+ @see com::sun::star::text::IllustrationsIndex
@see com::sun::star::text::TableIndex
@see com::sun::star::text::ObjectIndex
*/
commit 9ab5d436131df63c85945360520fe7ff948ee280
Author: Peter Foley <pefoley2 at verizon.net>
Date: Sun Mar 17 12:35:13 2013 -0400
fix javadoc warnings
Change-Id: I86176860504893213a25afc2a3a886cab9acad68
diff --git a/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java b/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java
index 0a8a924..cd8c51d 100644
--- a/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java
+++ b/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java
@@ -117,7 +117,7 @@ XMultiPropertySet
* initialization of the inheriting class (i.e. within the contructor)
* @param name The property's name (Property.Name).
* @param handle The property's handle (Property.Handle).
- * @param Type The property's type (Property.Type).
+ * @param type The property's type (Property.Type).
* @param attributes The property's attributes (Property.Attributes).
* @param id Identifies the property's storage.
*/
@@ -135,8 +135,7 @@ XMultiPropertySet
* Registration has to occur during
* initialization of the inheriting class (i.e. within the contructor).
* @param name The property's name (Property.Name).
- * @param handle The property's handle (Property.Handle).
- * @param Type The property's type (Property.Type).
+ * @param type The property's type (Property.Type).
* @param attributes The property's attributes (Property.Attributes).
* @param id Identifies the property's storage.
*/
@@ -788,7 +787,7 @@ XMultiPropertySet
* If a property has the READONLY attribute set, and one of the setter methods, such as setPropertyValue, has been
* called, then this method is not going to be called.
* @param property the property for which the new value is set
- * @param value the new value for the property.
+ * @param newVal the new value for the property.
* @throws com.sun.star.lang.WrappedTargetException An exception, which has to be made known to the caller,
* occurred during the setting of the value.
*/
diff --git a/odk/CustomTarget_javadoc.mk b/odk/CustomTarget_javadoc.mk
index 3795a9a..3f88d12 100644
--- a/odk/CustomTarget_javadoc.mk
+++ b/odk/CustomTarget_javadoc.mk
@@ -25,11 +25,12 @@ $(odk_WORKDIR)/docs/java/ref/index.html: $(call gb_Jar_get_outdir_target,ridl)
$(JAVADOC) -J-Xmx120m -use -splitindex \
-windowtitle "Java UNO Runtime Reference" \
-header "$(PRODUCTNAME) $(PRODUCTVERSION) SDK Java API Reference"\
+ -tag attention:a:"Attention:" \
-d $(dir $@) \
-sourcepath "$(SRCDIR)/ridljar/source/unoloader$(gb_CLASSPATHSEP)$(SRCDIR)/ridljar$(gb_CLASSPATHSEP)$(SRCDIR)/jurt$(gb_CLASSPATHSEP)$(SRCDIR)/javaunohelper" \
-classpath $(OUTDIR)/bin/ridl.jar \
- -linkoffline ../../common/reg ./uno \
- -linkoffline http://java.sun.com/j2se/1.5/docs/api ./java \
+ -linkoffline ../../common/reg $(SRCDIR)/odk/pack/gendocu/uno \
+ -linkoffline http://java.sun.com/j2se/1.5/docs/api $(SRCDIR)/odk/pack/gendocu/java \
$(odk_JAVAPACKAGES) \
$(if $(JAVADOCISGJDOC),,-notimestamp) \
> $(odk_WORKDIR)/javadoc_log.txt
More information about the Libreoffice-commits
mailing list