diff options
| author | Tor Lillqvist <tml@collabora.com> | 2014-04-06 19:36:43 +0300 |
|---|---|---|
| committer | Tor Lillqvist <tml@collabora.com> | 2014-04-06 19:37:48 +0300 |
| commit | f4e8d2ad0e591b87d2c221761363a3042628d5ff (patch) | |
| tree | e60c5dd70876182d0c578ca251d08d902d34886d /framework | |
| parent | ee3945bd98194010656fa9b3366e7471b9f160fd (diff) | |
Bin empty @seealso, @param, @return and @onerror metacomments
Change-Id: I30a761a21a98419816c4b67258664becd79e2db1
Diffstat (limited to 'framework')
23 files changed, 0 insertions, 494 deletions
diff --git a/framework/inc/classes/checkediterator.hxx b/framework/inc/classes/checkediterator.hxx index 8fca4a63f462..f17581e98578 100644 --- a/framework/inc/classes/checkediterator.hxx +++ b/framework/inc/classes/checkediterator.hxx @@ -36,8 +36,6 @@ namespace framework{ @Attention If your wish to debug this inline code ... under windows and msdev you can use "set ENVCFLAGS=/Ob0" to do that! - - @implements - @base - @devstatus ready to use @@ -59,12 +57,7 @@ class CheckedIterator @descr Set default values on members. We set it internal to E_UNKNOWN to detect uninitialized instances of this class. If we found one - we know: "We must call initialize first!" - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -81,12 +74,7 @@ class CheckedIterator @descr Set new container at an instance of this class. The other member will set automaticly! m_pPosition = first element in container m_eEndState = BEFOREEND - - @seealso - - @param "rContainer", must be a valid reference to an existing container. - @return - - @onerror An assertion is thrown. *//*-*****************************************************************************************************/ @@ -111,11 +99,7 @@ class CheckedIterator We need it to return one default value if no other ones exist ... @seealso using in class FilterCache! - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ inline void setEnd() @@ -130,11 +114,7 @@ class CheckedIterator We need it if we don't have a container but must prevent us against further searching! @seealso using in class FilterCache! - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ inline void setAfterEnd() @@ -148,11 +128,7 @@ class CheckedIterator @descr It must be called on an already initialized iterator. Means the member m_pContainer must be valid. Otherwise the reaction isn't defined. - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ inline void reset() @@ -170,11 +146,7 @@ class CheckedIterator @seealso method isEnd() @seealso method isAfterEnd() - - @param - @return A reference to our changed object himself. - - @onerror - *//*-*****************************************************************************************************/ inline CheckedIterator& operator++() @@ -207,11 +179,7 @@ class CheckedIterator @descr These will be true, if use start a new search by using these iterator mechanism! @seealso class FilterCache - - @param - @return True if internalk state E_UNKNOWN - false otherwise. - - @onerror - *//*-*****************************************************************************************************/ inline sal_Bool isUninitialized() @@ -224,11 +192,7 @@ class CheckedIterator @descr These will be true if you step to the end of internal container. @seealso method isAfterEnd() - - @param - @return True if end reached; false otherwise. - - @onerror - *//*-*****************************************************************************************************/ inline sal_Bool isEnd() @@ -245,11 +209,7 @@ class CheckedIterator @descr These indicate, that end already reached but you call operator++ again and again! @seealso method isEnd() - - @param - @return True if end multiple reached; false otherwise. - - @onerror - *//*-*****************************************************************************************************/ inline sal_Bool isAfterEnd() @@ -261,13 +221,8 @@ class CheckedIterator /*-**************************************************************************************************** @short support readonly access to container entry @descr Use it to get the value of current container item. - - @seealso - - @param - @return A reference to value of container entry. - - @onerror - *//*-*****************************************************************************************************/ inline typename TContainer::const_iterator getEntry() diff --git a/framework/inc/classes/filtercache.hxx b/framework/inc/classes/filtercache.hxx index cac2c2ae4596..cfb4fa2ee752 100644 --- a/framework/inc/classes/filtercache.hxx +++ b/framework/inc/classes/filtercache.hxx @@ -53,8 +53,6 @@ namespace framework{ @short cache for all filter and type information @descr Frameloader - and filterfactory need some information about our current registered filters and types. For better performance its necessary to cache all needed values. - - @implements - @base TransactionBase @devstatus ready to use @@ -77,12 +75,7 @@ class FilterCache : private TransactionBase /*-**************************************************************************************************** @short standard destructor to delete instance @descr This will clear the cache if last owner release it. - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -93,14 +86,8 @@ class FilterCache : private TransactionBase /*-**************************************************************************************************** @short get the current state of the cache @descr Call this methods to get information about the state of the current cache. - - @seealso - - @param - @return - - @return - - - @onerror - *//*-*****************************************************************************************************/ sal_Bool isValidOrRepairable() const; @@ -125,9 +112,6 @@ class FilterCache : private TransactionBase returned filter name is an internal name returned loader name is an implementation name of a service returned detector name is an implementation name of a service - - @seealso - - @param "sResult", name of found type, filter, ... @return true, if search was successful, false, otherwise. @@ -162,9 +146,6 @@ class FilterCache : private TransactionBase @descr If you need additional information about our internal cache values you can use these methods to get a list of all cached config values and subkeys of specified entry. - - @seealso - - @param "sName", name of suspected entry in cache @return A structure with valid information if item exists! An empty Any otherwise. @@ -253,9 +234,6 @@ class FilterCache : private TransactionBase PropertyValue.Name PropertyValue.Value Description --------------------------------------------------------------------------------------- ... - - @seealso - - @param "sName" , name of type, filter ... @param "lProperties" , values of new type, filter @return state of operation as bool diff --git a/framework/inc/classes/filtercachedata.hxx b/framework/inc/classes/filtercachedata.hxx index 5fd4d00ea939..beb5e67016c6 100644 --- a/framework/inc/classes/filtercachedata.hxx +++ b/framework/inc/classes/filtercachedata.hxx @@ -569,8 +569,6 @@ class DataContainer We set a data container pointer for filling or reading ... this class use it temp. After successfully calling of read(), we can use filled container directly or merge it with an existing one. After successfully calling of write() all values of given data container are flushed to our configuration. - - @implements - @base ConfigItem @devstatus ready to use diff --git a/framework/inc/classes/wildcard.hxx b/framework/inc/classes/wildcard.hxx index f50f16df06be..626ee572ec42 100644 --- a/framework/inc/classes/wildcard.hxx +++ b/framework/inc/classes/wildcard.hxx @@ -28,8 +28,6 @@ namespace framework{ @short implement wildcard-mechanism for unicode @descr This class can be used to get information about the matching of a pattern to a given text. It's suitable for 8-Bit- AND 16-Bit-strings! - - @implements - @base - @ATTENTION This class is'nt threadsafe! @@ -49,12 +47,7 @@ class Wildcard /*-**************************************************************************************************** @short standard ctor @descr We do nothing here. - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -63,12 +56,7 @@ class Wildcard /*-**************************************************************************************************** @short standard dtor @descr We do nothing here. - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -79,15 +67,10 @@ class Wildcard /*-**************************************************************************************************** @short try to find an agreement between given text and searchpattern @descr You can use wildcards in pattern only! - - @seealso - - @param "sText" is the text, in which we search given pattern. @param "sPattern" is the searched pattern with includes wildcards. @return sal_True , if pattern was found. @return sal_False, if pattern don't match the text. - - @onerror - *//*-*****************************************************************************************************/ static sal_Bool match( const OUString& sText , diff --git a/framework/inc/dispatch/menudispatcher.hxx b/framework/inc/dispatch/menudispatcher.hxx index be4102791c40..30faccb32308 100644 --- a/framework/inc/dispatch/menudispatcher.hxx +++ b/framework/inc/dispatch/menudispatcher.hxx @@ -88,8 +88,6 @@ class MenuDispatcher : public ::cppu::WeakImplHelper2< @param "rxContext" , css::uno::Reference to servicemanager for creation of new services @param "xOwner" , css::uno::Reference to our owner, the Desktop!!! - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -101,13 +99,8 @@ class MenuDispatcher : public ::cppu::WeakImplHelper2< /*-**************************************************************************************************** @short dispatch URL with arguments @descr Every dispatch create a new task. If load of URL failed task will deleted automaticly! - - @seealso - - @param "aURL" , URL to dispatch. @param "seqArguments" , list of optional arguments. - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -123,8 +116,6 @@ class MenuDispatcher : public ::cppu::WeakImplHelper2< @param "xControl" , css::uno::Reference to a valid listener for state events. @param "aURL" , URL about listener will be informed, if something occurred. - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -140,8 +131,6 @@ class MenuDispatcher : public ::cppu::WeakImplHelper2< @param "xControl" , css::uno::Reference to a valid listener. @param "aURL" , URL on which listener has registered. - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -157,12 +146,7 @@ class MenuDispatcher : public ::cppu::WeakImplHelper2< /*-**************************************************************************************************** @short dispose current instance @descr If service helper isn't required any longer call this method to release all used resources. - - @seealso - - @param "aEvent", information about source of this event. - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -177,12 +161,7 @@ class MenuDispatcher : public ::cppu::WeakImplHelper2< @descr This method destruct an instance of this class and clear some member. This method is protected, because its not allowed to use an instance of this class as a member! You MUST use a pointer. - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -193,28 +172,16 @@ class MenuDispatcher : public ::cppu::WeakImplHelper2< private: /*-**************************************************************************************************** - @short - @descr - - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ sal_Bool impl_setMenuBar( MenuBar* pMenuBar, sal_Bool bMenuFromResource = sal_False ); /*-**************************************************************************************************** - @short - @descr - - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ diff --git a/framework/inc/helper/dockingareadefaultacceptor.hxx b/framework/inc/helper/dockingareadefaultacceptor.hxx index 7bfc6535a22f..1920a7b766b0 100644 --- a/framework/inc/helper/dockingareadefaultacceptor.hxx +++ b/framework/inc/helper/dockingareadefaultacceptor.hxx @@ -49,8 +49,6 @@ class DockingAreaDefaultAcceptor : public ::cppu::WeakImplHelper1< ::com::s @param "xOwner" is a reference to ouer owner and must be the desktop! @param "pTasks" is a pointer to the taskcontainer of the desktop. We need it to create a new enumeration. - @return - - @onerror Do nothing and reset this object to default with an empty list. *//*-*****************************************************************************************************/ diff --git a/framework/inc/helper/ocomponentaccess.hxx b/framework/inc/helper/ocomponentaccess.hxx index 405c6b0f6adc..836f0315c5ba 100644 --- a/framework/inc/helper/ocomponentaccess.hxx +++ b/framework/inc/helper/ocomponentaccess.hxx @@ -73,8 +73,6 @@ class OComponentAccess : public ::cppu::WeakImplHelper1< ::com::sun::star::co @seealso class OComponentEnumeration @param "xOwner" is a reference to ouer owner and must be the desktop! - @return - - @onerror Do nothing and reset this object to default with an empty list. *//*-*****************************************************************************************************/ @@ -89,12 +87,8 @@ class OComponentAccess : public ::cppu::WeakImplHelper1< ::com::sun::star::co @seealso interface XEnumerationAccess @seealso interface XEnumeration @seealso class Desktop - - @param - @return If the desktop and some components exist => a valid reference to an enumeration<BR> An NULL-reference, other way. - - @onerror - *//*-*****************************************************************************************************/ virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createEnumeration() throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE; @@ -103,30 +97,18 @@ class OComponentAccess : public ::cppu::WeakImplHelper1< ::com::sun::star::co /*-**************************************************************************************************** @short get the type of elements in enumeration - @descr - - @seealso interface XElementAccess @seealso class OComponentEnumeration - - @param - @return The uno-type XComponent. - - @onerror - *//*-*****************************************************************************************************/ virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE; /*-**************************************************************************************************** @short get state of componentlist of enumeration. - @descr - - @seealso interface XElementAccess - - @param - @return sal_True ,if more then 0 elements exist. @return sal_False ,otherwise. - - @onerror - *//*-*****************************************************************************************************/ virtual sal_Bool SAL_CALL hasElements() throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE; @@ -143,11 +125,7 @@ class OComponentAccess : public ::cppu::WeakImplHelper1< ::com::sun::star::co Thats the reason for a protected dtor. @seealso class Desktop - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ virtual ~OComponentAccess(); @@ -165,8 +143,6 @@ class OComponentAccess : public ::cppu::WeakImplHelper1< ::com::sun::star::co @param "xNode" , root of subtree and start point of search @param "seqComponents", result list of search. We cant use a return value, we search recursive and must collect all information. - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -200,8 +176,6 @@ class OComponentAccess : public ::cppu::WeakImplHelper1< ::com::sun::star::co @param references to checking variables @return sal_False ,on invalid parameter. @return sal_True ,otherwise - - @onerror - *//*-*****************************************************************************************************/ private: diff --git a/framework/inc/helper/ocomponentenumeration.hxx b/framework/inc/helper/ocomponentenumeration.hxx index 39f77d76bfba..c98bb2154695 100644 --- a/framework/inc/helper/ocomponentenumeration.hxx +++ b/framework/inc/helper/ocomponentenumeration.hxx @@ -63,12 +63,7 @@ class OComponentEnumeration : public ::cppu::WeakImplHelper2< ::com::sun::star @short constructor to initialize this enumeration @descr An enumeration is a list with oneway-access! You can get every member only for one time. This method allow to initialize this oneway list with values. - - @seealso - - @param "seqComponents" is a sequence of interfaces, which are components. - @return - - @onerror Do nothing and reset this object to default with an empty list. *//*-*****************************************************************************************************/ @@ -84,8 +79,6 @@ class OComponentEnumeration : public ::cppu::WeakImplHelper2< ::com::sun::star @seealso interface XEventListener @param "aEvent" describe the source of this event. - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -99,8 +92,6 @@ class OComponentEnumeration : public ::cppu::WeakImplHelper2< ::com::sun::star Elements you have already getted are not accessible! @seealso interface XEnumeration - - @param - @return sal_True = if more elements accessible<BR> sal_False = other way @@ -115,8 +106,6 @@ class OComponentEnumeration : public ::cppu::WeakImplHelper2< ::com::sun::star @descr If a call "hasMoreElements()" return true, you can get the next element of list. @seealso interface XEnumeration - - @param - @return A Reference to a component, safed in an Any-structure. @onerror If end of enumeration is arrived or there are no elements in list => a NoSuchElementException is thrown. @@ -135,12 +124,7 @@ class OComponentEnumeration : public ::cppu::WeakImplHelper2< ::com::sun::star @descr This method destruct an instance of this class and clear some member. We make it protected, because its not supported to use this class as normal instance! You must create it dynamical in memory and use a pointer. - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -156,12 +140,7 @@ class OComponentEnumeration : public ::cppu::WeakImplHelper2< ::com::sun::star @seealso method dispose() @seealso destructor ~TaskEnumeration() - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ virtual void impl_resetObject(); @@ -183,8 +162,6 @@ class OComponentEnumeration : public ::cppu::WeakImplHelper2< ::com::sun::star @param references to checking variables @return sal_False on invalid parameter<BR> sal_True otherway - - @onerror - *//*-*****************************************************************************************************/ private: diff --git a/framework/inc/helper/oframes.hxx b/framework/inc/helper/oframes.hxx index 687960b6546e..d111a1c956cb 100644 --- a/framework/inc/helper/oframes.hxx +++ b/framework/inc/helper/oframes.hxx @@ -62,13 +62,8 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @short standard ctor @descr These initialize a new instance of this class with all needed information for work. We share framecontainer with owner implementation! It's a threadsafe container. - - @seealso - - @param xOwner , reference to ouer owner. We hold a wekreference to prevent us against cross-references! @param pFrameContainer , pointer to shared framecontainer of owner. It's valid only, if weakreference is valid! - @return - - @onerror - *//*-*****************************************************************************************************/ OFrames( const css::uno::Reference< css::frame::XFrame >& xOwner , @@ -84,8 +79,6 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @seealso class FrameContainer @param "xFrame", reference to an existing frame to append. - @return - - @onerror We do nothing in release or throw an assert in debug version. *//*-*****************************************************************************************************/ virtual void SAL_CALL append( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE; @@ -98,8 +91,6 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @seealso class FrameContainer @param "xFrame", reference to an existing frame to remove. - @return - - @onerror We do nothing in release or throw an assert in debug version. *//*-*****************************************************************************************************/ virtual void SAL_CALL remove( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE; @@ -107,9 +98,6 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr /*-**************************************************************************************************** @short return list of all applicable frames for given flags @descr Call these to get a list of all frames, which are match with given search flags. - - @seealso - - @param "nSearchFlag", flags to search right frames. @return A list of founded frames. @@ -126,8 +114,6 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @seealso class FrameContainer @seealso method getByIndex() - - @param - @return Count of current items in container. @onerror If a lock is set, we return 0 for prevent further access! @@ -158,13 +144,8 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @short get uno-type of all container items @descr In current implementation type is fixed to XFrame! (container-lock is ignored) - - @seealso - - @param - @return A uno-type descriptor. - - @onerror - *//*-*****************************************************************************************************/ virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE; @@ -172,9 +153,6 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @short get fill state of current container @descr Call these to get information about, if items exist in container or not. (container-lock is ignored) - - @seealso - - @param - @return sal_True, if container contains some items. @return sal_False, otherwise. @@ -190,12 +168,7 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @descr This method destruct an instance of this class and clear some member. This method is protected, because its not allowed to use this class as a member! You MUST use a dynamical instance (pointer). That's the reason for a protected dtor. - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ virtual ~OFrames(); @@ -209,12 +182,7 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @seealso method dispose() (if it exist!) @seealso destructor ~TaskEnumeration() - - @param - - @return - - - @onerror - *//*-*****************************************************************************************************/ virtual void impl_resetObject(); @@ -229,8 +197,6 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @param "seqDestination", reference to sequence on which operation will append the other sequence. @param "seqSource" , reference to sequence for append. @return "seqDestination" is parameter AND return value at the same time. - - @onerror - *//*-*****************************************************************************************************/ void impl_appendSequence( css::uno::Sequence< css::uno::Reference< css::frame::XFrame > >& seqDestination , const css::uno::Sequence< css::uno::Reference< css::frame::XFrame > >& seqSource ); @@ -248,8 +214,6 @@ class OFrames : public ::cppu::WeakImplHelper1< ::com::sun::star::frame::XFr @param references to checking variables @return sal_False ,on invalid parameter @return sal_True ,otherwise - - @onerror - *//*-*****************************************************************************************************/ private: diff --git a/framework/inc/interaction/quietinteraction.hxx b/framework/inc/interaction/quietinteraction.hxx index 4f23e666c938..c2456c15e7cb 100644 --- a/framework/inc/interaction/quietinteraction.hxx +++ b/framework/inc/interaction/quietinteraction.hxx @@ -79,8 +79,6 @@ class QuietInteraction : public ::cppu::WeakImplHelper1< public: /** @short ctor to guarantee right initialized instances of this class - @descr - - @threadsafe not necessary */ QuietInteraction(); diff --git a/framework/inc/services/mediatypedetectionhelper.hxx b/framework/inc/services/mediatypedetectionhelper.hxx index d5ba2b6df3cd..401152aab157 100644 --- a/framework/inc/services/mediatypedetectionhelper.hxx +++ b/framework/inc/services/mediatypedetectionhelper.hxx @@ -35,7 +35,6 @@ namespace framework{ /*-************************************************************************************************************ - @short - @descr - @implements XInterface @@ -59,12 +58,7 @@ class MediaTypeDetectionHelper : public ::cppu::WeakImplHelper2< ::com::sun:: /*-**************************************************************************************************** @short standard ctor @descr These initialize a new instance of this class with all needed information for work. - - @seealso - - @param "xFactory", reference to factory which has created ouer owner(!). We can use these to create new uno-services. - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -73,12 +67,7 @@ class MediaTypeDetectionHelper : public ::cppu::WeakImplHelper2< ::com::sun:: /*-**************************************************************************************************** @short standard destructor @descr This method destruct an instance of this class and clear some member. - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -91,14 +80,8 @@ class MediaTypeDetectionHelper : public ::cppu::WeakImplHelper2< ::com::sun:: // XStringMapping /*-**************************************************************************************************** - @short - @descr - - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ diff --git a/framework/inc/threadhelp/gate.hxx b/framework/inc/threadhelp/gate.hxx index deaa0b4a8258..1bc2b782f8f5 100644 --- a/framework/inc/threadhelp/gate.hxx +++ b/framework/inc/threadhelp/gate.hxx @@ -53,12 +53,7 @@ class Gate : public IGate /*-**************************************************************************************************** @short ctor @descr These initialize the object right as an open gate. - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ inline Gate() @@ -73,12 +68,7 @@ class Gate : public IGate @descr Is user forget it - we open the gate ... blocked threads can running ... but I don't know if it's right - we are destroyed yet!? - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ inline virtual ~Gate() @@ -92,11 +82,7 @@ class Gate : public IGate @descr A wait() call will not block then. @seealso method close() - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ virtual void open() SAL_OVERRIDE { @@ -115,11 +101,7 @@ class Gate : public IGate @descr A wait() call will block then. @seealso method open() - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ virtual void close() SAL_OVERRIDE { @@ -141,11 +123,7 @@ class Gate : public IGate @seealso method wait() @seealso method open() - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ virtual void openGap() SAL_OVERRIDE { diff --git a/framework/inc/threadhelp/transactionbase.hxx b/framework/inc/threadhelp/transactionbase.hxx index 4d2cd5b1b363..7c16e1e954d6 100644 --- a/framework/inc/threadhelp/transactionbase.hxx +++ b/framework/inc/threadhelp/transactionbase.hxx @@ -30,8 +30,6 @@ namespace framework{ you should have a look on this implementation. You must use it as the first base class of your implementation - because base classes are initialized by his order and before your member! Thats why ist a good place to declare this member. - - @implements - @base - @devstatus ready to use diff --git a/framework/inc/threadhelp/transactionguard.hxx b/framework/inc/threadhelp/transactionguard.hxx index 2423b6eb3475..596ae0333cd8 100644 --- a/framework/inc/threadhelp/transactionguard.hxx +++ b/framework/inc/threadhelp/transactionguard.hxx @@ -36,9 +36,6 @@ namespace framework{ transaction requests ... e.g. interface call for already disposed objects. @attention To prevent us against wrong using, the default ctor, copy ctor and the =operator are maked private! - - @implements - - @devstatus draft *//*-*************************************************************************************************************/ class TransactionGuard : private boost::noncopyable @@ -55,14 +52,9 @@ class TransactionGuard : private boost::noncopyable @attention It's not necessary to lock any mutex here! Because a ctor should not be called from different threads at the same time ... this class use no refcount mechanism! - - @seealso - - @param "rManager" reference to transaction manager for using to register a request @param "eMode" enable/disable throwing of exceptions for rejected calls @param "eReason" returns reason for rejected calls if "eMode=E_NOEXCEPTIONS"! - @return - - @onerror - *//*-*****************************************************************************************************/ inline TransactionGuard( ITransactionManager& rManager, EExceptionMode eMode, ERejectReason* eReason = NULL ) @@ -85,12 +77,7 @@ class TransactionGuard : private boost::noncopyable /*-************************************************************************************************************ @short dtor @descr We must release the transaction manager and can forget his pointer. - - @seealso - - @param - - @return - - @onerror - *//*-*************************************************************************************************************/ inline ~TransactionGuard() @@ -105,12 +92,7 @@ class TransactionGuard : private boost::noncopyable @attention We don't support any start() method here - because it is not easy to detect if a transaction already started or not! (combination of EExceptionMode and ERejectReason) - - @seealso - - @param - - @return - - @onerror - *//*-*************************************************************************************************************/ inline void stop() @@ -132,11 +114,7 @@ class TransactionGuard : private boost::noncopyable Thats why we disable it by make it private. @seealso other ctor - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ TransactionGuard(); diff --git a/framework/source/classes/framecontainer.cxx b/framework/source/classes/framecontainer.cxx index 32e52be8f386..5e4806fc23f9 100644 --- a/framework/source/classes/framecontainer.cxx +++ b/framework/source/classes/framecontainer.cxx @@ -99,8 +99,6 @@ void FrameContainer::remove( const css::uno::Reference< css::frame::XFrame >& xF /**-*************************************************************************************************************** @short check if the given frame currently exist inside the container - @descr - - @param xFrame reference to the queried frame @@ -117,8 +115,6 @@ sal_Bool FrameContainer::exist( const css::uno::Reference< css::frame::XFrame >& /**-*************************************************************************************************************** @short delete all existing items of the container - @descr - - @threadsafe yes *****************************************************************************************************************/ void FrameContainer::clear() @@ -134,8 +130,6 @@ void FrameContainer::clear() /**-*************************************************************************************************************** @short returns count of all current existing frames - @descr - - @deprecated This value can't be guaranteed for multithreading environments. So it will be marked as deprecated and should be replaced by "getAllElements()". @@ -151,8 +145,6 @@ sal_uInt32 FrameContainer::getCount() const /**-*************************************************************************************************************** @short returns one item of this container - @descr - - @deprecated This value can't be guaranteed for multithreading environments. So it will be marked as deprecatedf and should be replaced by "getAllElements()". diff --git a/framework/source/dispatch/mailtodispatcher.cxx b/framework/source/dispatch/mailtodispatcher.cxx index 409970392ae6..160bddc5fcb1 100644 --- a/framework/source/dispatch/mailtodispatcher.cxx +++ b/framework/source/dispatch/mailtodispatcher.cxx @@ -60,7 +60,6 @@ MailToDispatcher::MailToDispatcher( const css::uno::Reference< css::uno::XCompon /** @short standard dtor - @descr - */ MailToDispatcher::~MailToDispatcher() { @@ -87,7 +86,6 @@ css::uno::Reference< css::frame::XDispatch > SAL_CALL MailToDispatcher::queryDis /** @short do the same like dispatch() but for multiple requests at the same time - @descr - */ css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL MailToDispatcher::queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor ) throw( css::uno::RuntimeException, std::exception ) { diff --git a/framework/source/dispatch/oxt_handler.cxx b/framework/source/dispatch/oxt_handler.cxx index eac9f2daf027..ee1806f81c79 100644 --- a/framework/source/dispatch/oxt_handler.cxx +++ b/framework/source/dispatch/oxt_handler.cxx @@ -51,8 +51,6 @@ DEFINE_INIT_SERVICE ( Oxt_Handler, @seealso using at owner @param "xFactory", reference to service manager for creation of new services - @return - - @onerror Show an assertion and do nothing else. @threadsafe yes *//*-*************************************************************************************************************/ @@ -63,14 +61,8 @@ Oxt_Handler::Oxt_Handler( const css::uno::Reference< css::lang::XMultiServiceFac /*-************************************************************************************************************ @short standard dtor - @descr - - @seealso - - - @param - @return - - - @onerror - @threadsafe - *//*-*************************************************************************************************************/ Oxt_Handler::~Oxt_Handler() @@ -101,8 +93,6 @@ Oxt_Handler::~Oxt_Handler() @param "aURL" , URL to dispatch. @param "lArguments", list of optional arguments. - @return - - @onerror We do nothing. @threadsafe yes *//*-*************************************************************************************************************/ @@ -154,9 +144,6 @@ void SAL_CALL Oxt_Handler::dispatch( const css::util::URL& Another reason to do so ... We are a listener on our internal ma_Player object. If you would call "IsSoundFile()" on this instance, he would call us back and we make some unnecessary things ... - - @seealso - - @param "lDescriptor", description of file to detect @return Internal type name which match this file ... or nothing if it is unknown. diff --git a/framework/source/dispatch/servicehandler.cxx b/framework/source/dispatch/servicehandler.cxx index 6b5630c64061..46d8ecde9b3b 100644 --- a/framework/source/dispatch/servicehandler.cxx +++ b/framework/source/dispatch/servicehandler.cxx @@ -62,7 +62,6 @@ ServiceHandler::ServiceHandler( const css::uno::Reference< css::lang::XMultiServ /** @short standard dtor - @descr - */ ServiceHandler::~ServiceHandler() { @@ -89,7 +88,6 @@ css::uno::Reference< css::frame::XDispatch > SAL_CALL ServiceHandler::queryDispa /** @short do the same like dispatch() but for multiple requests at the same time - @descr - */ css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL ServiceHandler::queryDispatches( const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor ) throw( css::uno::RuntimeException, std::exception ) { diff --git a/framework/source/fwe/classes/addonsoptions.cxx b/framework/source/fwe/classes/addonsoptions.cxx index 368131890c62..7c5f49f88223 100644 --- a/framework/source/fwe/classes/addonsoptions.cxx +++ b/framework/source/fwe/classes/addonsoptions.cxx @@ -221,8 +221,6 @@ class AddonsOptions_Impl : public ConfigItem @seealso baseclass ConfigItem @param "lPropertyNames" is the list of properties which should be updated. - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -234,11 +232,7 @@ class AddonsOptions_Impl : public ConfigItem and should always called in our destructor to guarantee consistency of config data. @seealso baseclass ConfigItem - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ virtual void Commit() SAL_OVERRIDE; @@ -249,12 +243,7 @@ class AddonsOptions_Impl : public ConfigItem @short base implementation of public interface for "SvtDynamicMenuOptions"! @descr These class is used as static member of "SvtDynamicMenuOptions" ... => The code exist only for one time and isn't duplicated for every instance! - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ @@ -302,13 +291,8 @@ class AddonsOptions_Impl : public ConfigItem @short return list of key names of our configuration management which represent oue module tree @descr These methods return the current list of key names! We need it to get needed values from our configuration management! - - @seealso - - @param "nCount" , returns count of menu entries for "new" @return A list of configuration key names is returned. - - @onerror - *//*-*****************************************************************************************************/ bool ReadAddonMenuSet( Sequence< Sequence< PropertyValue > >& aAddonMenuSeq ); diff --git a/framework/source/fwi/threadhelp/transactionmanager.cxx b/framework/source/fwi/threadhelp/transactionmanager.cxx index a5cbf48e30c4..7c1ef34eafa3 100644 --- a/framework/source/fwi/threadhelp/transactionmanager.cxx +++ b/framework/source/fwi/threadhelp/transactionmanager.cxx @@ -28,12 +28,7 @@ namespace framework{ /*-************************************************************************************************************ @short standard ctor @descr Initialize instance with right start values for correct working. - - @seealso - - @param - - @return - - @onerror - *//*-*************************************************************************************************************/ TransactionManager::TransactionManager() @@ -45,14 +40,8 @@ TransactionManager::TransactionManager() /*-************************************************************************************************************ @short standard dtor - @descr - - @seealso - - - @param - @return - - - @onerror - *//*-*************************************************************************************************************/ TransactionManager::~TransactionManager() { @@ -78,12 +67,7 @@ TransactionManager::~TransactionManager() E_CLOSE : Object is already dead! All further requests will be refused. It's your decision to react in a right way. - - @seealso - - @param "eMode", is the new mode - but we don't accept setting mode in wrong order! - @return - - @onerror We do nothing. *//*-*****************************************************************************************************/ void TransactionManager::setWorkingMode( EWorkingMode eMode ) @@ -151,8 +135,6 @@ void TransactionManager::setWorkingMode( EWorkingMode eMode ) } @seealso method setWorkingMode() - - @param - @return Current set mode. @onerror No error should occur. @@ -176,8 +158,6 @@ EWorkingMode TransactionManager::getWorkingMode() const @param "eMode" ,used to enable/disable throwing exceptions automatically for rejected calls @param "eReason" ,reason for rejected calls if eMode=E_NOEXCEPTIONS - @return - - @onerror - *//*-*****************************************************************************************************/ void TransactionManager::registerTransaction( EExceptionMode eMode, ERejectReason& eReason ) throw( css::uno::RuntimeException, css::lang::DisposedException ) @@ -212,11 +192,7 @@ void TransactionManager::registerTransaction( EExceptionMode eMode, ERejectReas @descr A guard should call this method to release current transaction. @seealso method registerTransaction() - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ void TransactionManager::unregisterTransaction() throw( css::uno::RuntimeException, css::lang::DisposedException ) { @@ -240,9 +216,6 @@ void TransactionManager::unregisterTransaction() throw( css::uno::RuntimeExcept @short look for rejected calls @descr Sometimes user need a possibility to get information about rejected calls without starting a transaction! - - @seealso - - @param "eReason" returns reason of a rejected call @return true if call was rejected, false otherwise @@ -280,8 +253,6 @@ sal_Bool TransactionManager::isCallRejected( ERejectReason& eReason ) const @param "eReason" , reason for rejected call @param "eMode" , exception mode - set by user - @return - - @onerror - *//*-*****************************************************************************************************/ void TransactionManager::impl_throwExceptions( EExceptionMode eMode, ERejectReason eReason ) const throw( css::uno::RuntimeException, css::lang::DisposedException ) diff --git a/framework/source/jobs/jobresult.cxx b/framework/source/jobs/jobresult.cxx index 535ee7a0642c..8544172a3f06 100644 --- a/framework/source/jobs/jobresult.cxx +++ b/framework/source/jobs/jobresult.cxx @@ -128,7 +128,6 @@ JobResult::JobResult( /*IN*/ const css::uno::Any& aResult ) /** @short copy dtor - @descr - */ JobResult::JobResult( const JobResult& rCopy ) { diff --git a/framework/source/services/desktop.cxx b/framework/source/services/desktop.cxx index 6db80cbb58d5..c60fe59c482f 100644 --- a/framework/source/services/desktop.cxx +++ b/framework/source/services/desktop.cxx @@ -147,8 +147,6 @@ void Desktop::constructorInit() @param "xFactory" is the multi service manager, which create this instance. The value must be different from NULL! - @return - - @onerror We throw an ASSERT in debug version or do nothing in relaese version. *//*-*************************************************************************************************************/ Desktop::Desktop( const css::uno::Reference< css::uno::XComponentContext >& xContext ) @@ -183,11 +181,7 @@ Desktop::Desktop( const css::uno::Reference< css::uno::XComponentContext >& xCon @descr This one do NOTHING! Use dispose() instaed of this. @seealso method dispose() - - @param - @return - - - @onerror - *//*-*************************************************************************************************************/ Desktop::~Desktop() { @@ -455,8 +449,6 @@ void SAL_CALL Desktop::removeTerminateListener( const css::uno::Reference< css:: @seealso class TasksAccess @seealso class TasksEnumeration - - @param - @return A reference to an XEnumerationAccess-object. @onerror We return a null-reference. @@ -482,8 +474,6 @@ css::uno::Reference< css::container::XEnumerationAccess > SAL_CALL Desktop::getC @seealso method getCurrentFrame() @seealso method impl_getFrameComponent() - - @param - @return A reference to the component. @onerror We return a null-reference. @@ -518,8 +508,6 @@ css::uno::Reference< css::lang::XComponent > SAL_CALL Desktop::getCurrentCompone a direct child of us and should be a part(!) of an active path. @seealso method getActiveFrame() - - @param - @return A valid reference, if there is an active frame. A null reference , otherwise. @@ -554,9 +542,6 @@ css::uno::Reference< css::frame::XFrame > SAL_CALL Desktop::getCurrentFrame() th @descr You can give us some information about the content, which you will load into a frame. We search or create this target for you, make a type detection of given URL and try to load it. As result of this operation we return the new created component or nothing, if loading failed. - - @seealso - - @param "sURL" , URL, which represant the content @param "sTargetFrameName" , name of target frame or special value like "_self", "_blank" ... @param "nSearchFlags" , optional arguments for frame search, if target isn't a special one @@ -599,8 +584,6 @@ But; Don't forget - you will be the owner of returned object and must release it @attention Normaly we don't need any lock here. We don't work on internal member! @seealso class TasksAccess - - @param - @return A reference to an accessobject, which can create enumerations of ouer childtasks. @onerror A null reference is returned. @@ -623,8 +606,6 @@ css::uno::Reference< css::container::XEnumerationAccess > SAL_CALL Desktop::getT b) We don't need any lock here. Our container is threadsafe himself and live, if we live! @seealso method getCurrentFrame() - - @param - @return A reference to ouer current active taskchild. @onerror A null reference is returned. @@ -730,8 +711,6 @@ void SAL_CALL Desktop::releaseDispatchProviderInterceptor ( const css::uno::Refe @attention Helper is threadsafe himself. So we don't need any lock here. @seealso class OFrames - - @param - @return A reference to the helper. @onerror A null reference is returned. @@ -799,14 +778,8 @@ css::uno::Reference< css::frame::XFrame > SAL_CALL Desktop::getActiveFrame() thr @short non implemented methods! @descr Some method make no sense for our desktop! He has no window or parent or ... So we should implement it empty and warn programmer, if he use it! - - @seealso - - @param - - @return - - @onerror - - @threadsafe - */ void SAL_CALL Desktop::initialize( const css::uno::Reference< css::awt::XWindow >& ) throw( css::uno::RuntimeException, std::exception ) { @@ -1119,12 +1092,7 @@ void SAL_CALL Desktop::disposing() You must releas ethis listener reference during your own disposing() method. @attention Our container is threadsafe himeslf. So we don't need any lock here. - - @seealso - - @param "xListener", reference to valid listener. We don't accept invalid values! - @return - - @onerror - @threadsafe yes */ @@ -1163,8 +1131,6 @@ void SAL_CALL Desktop::removeEventListener( const css::uno::Reference< css::lang @seealso method loadComponentFromURL() @param "aEvent", state event which (hopefully) valid information - @return - - @onerror - @threadsafe yes *//*-*************************************************************************************************************/ @@ -1195,11 +1161,7 @@ void SAL_CALL Desktop::dispatchFinished( const css::frame::DispatchResultEvent& We are a temp. listener only and our lifetime isn't smaller then of our temp. used dispatcher. @seealso method loadComponentFromURL() - - @param - @return - - - @onerror - @threadsafe - *//*-*************************************************************************************************************/ void SAL_CALL Desktop::disposing( const css::lang::EventObject& ) throw( css::uno::RuntimeException, std::exception ) @@ -1225,8 +1187,6 @@ void SAL_CALL Desktop::disposing( const css::lang::EventObject& ) throw( css::un @seealso member m_eLoadState @param "xRequest", request for interaction - normal a wrapped target exception from bottom services - @return - - @onerror - @threadsafe yes *//*-*************************************************************************************************************/ @@ -1415,8 +1375,6 @@ sal_Bool SAL_CALL Desktop::convertFastPropertyValue( css::uno::Any& aCon @param "nHandle" handle of property to change @param "aValue" new value of property - @return - - @onerror An exception is thrown. @threadsafe yes *//*-*************************************************************************************************************/ @@ -1449,8 +1407,6 @@ void SAL_CALL Desktop::setFastPropertyValue_NoBroadcast( sal_Int32 @param "nHandle" handle of property to change @param "aValue" current value of property - @return - - @onerror - @threadsafe yes *//*-*************************************************************************************************************/ @@ -1486,11 +1442,7 @@ void SAL_CALL Desktop::getFastPropertyValue( css::uno::Any& aValue , So we could have two different mutex/lock mechanism at the same object. @seealso class OPropertySetHelper - - @param - @return structure with property-information - - @onerror - @threadsafe yes *//*-*************************************************************************************************************/ ::cppu::IPropertyArrayHelper& SAL_CALL Desktop::getInfoHelper() @@ -1534,11 +1486,7 @@ void SAL_CALL Desktop::getFastPropertyValue( css::uno::Any& aValue , @seealso class OPropertySetHelper @seealso interface XPropertySet @seealso interface XMultiPropertySet - - @param - @return reference to object with information [XPropertySetInfo] - - @onerror - @threadsafe yes *//*-*************************************************************************************************************/ css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL Desktop::getPropertySetInfo() throw (::com::sun::star::uno::RuntimeException, std::exception) @@ -1629,11 +1577,7 @@ css::uno::Reference< css::lang::XComponent > Desktop::impl_getFrameComponent( co @seealso class OPropertySetHelper @seealso method getInfoHelper() - - @param - @return Static table with information about properties. - - @onerror - @threadsafe yes *//*-*************************************************************************************************************/ const css::uno::Sequence< css::beans::Property > Desktop::impl_getStaticPropertyDescriptor() diff --git a/framework/source/services/frame.cxx b/framework/source/services/frame.cxx index dc0abd799480..ce3f9bf11131 100644 --- a/framework/source/services/frame.cxx +++ b/framework/source/services/frame.cxx @@ -521,8 +521,6 @@ DEFINE_XTYPEPROVIDER_21 ( Frame @param xContext is the multi service manager, which creates this instance. The value must be different from NULL! - @return - - @onerror ASSERT in debug version or nothing in relaese version. *//*-*****************************************************************************************************/ Frame::Frame( const css::uno::Reference< css::uno::XComponentContext >& xContext ) @@ -605,11 +603,7 @@ void Frame::initListeners() @descr This one do NOTHING! Use dispose() instaed of this. @seealso method dispose() - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ Frame::~Frame() { @@ -622,9 +616,6 @@ Frame::~Frame() @descr You can give us some information about the content, which you will load into a frame. We search or create this target for you, make a type detection of given URL and try to load it. As result of this operation we return the new created component or nothing, if loading failed. - - @seealso - - @param "sURL" , URL, which represant the content @param "sTargetFrameName" , name of target frame or special value like "_self", "_blank" ... @param "nSearchFlags" , optional arguments for frame search, if target isn't a special one @@ -666,8 +657,6 @@ css::uno::Reference< css::lang::XComponent > SAL_CALL Frame::loadComponentFromUR a reference to the helper. @seealso class OFrames - - @param - @return A reference to the helper which answer your queries. @onerror A null reference is returned. @@ -700,8 +689,6 @@ css::uno::Reference< css::frame::XFrames > SAL_CALL Frame::getFrames() throw( cs @seealso class OFrameContainer @seealso method setActiveFrame() - - @param - @return A reference to ouer current active childframe, if anyone exist. @return A null reference, if nobody is active. @@ -729,8 +716,6 @@ css::uno::Reference< css::frame::XFrame > SAL_CALL Frame::getActiveFrame() throw @seealso method getActiveFrame() @param "xFrame", reference to new active child. It must be an already existing child! - @return - - @onerror An assertion is thrown and element is ignored, if given frame is'nt already a child of us. *//*-*****************************************************************************************************/ void SAL_CALL Frame::setActiveFrame( const css::uno::Reference< css::frame::XFrame >& xFrame ) throw( css::uno::RuntimeException, std::exception ) @@ -842,8 +827,6 @@ void lcl_disableLayoutManager(const css::uno::Reference< css::frame::XLayoutMana @seealso member m_xContainerWindow @param "xWindow", reference to new container window - must be valid! - @return - - @onerror We do nothing. *//*-*****************************************************************************************************/ void SAL_CALL Frame::initialize( const css::uno::Reference< css::awt::XWindow >& xWindow ) throw( css::uno::RuntimeException, std::exception ) @@ -923,8 +906,6 @@ void SAL_CALL Frame::initialize( const css::uno::Reference< css::awt::XWindow >& The frame is the owner of its container window. @seealso method initialize() - - @param - @return A reference to current set containerwindow. @onerror A null reference is returned. @@ -975,8 +956,6 @@ void SAL_CALL Frame::setCreator( const css::uno::Reference< css::frame::XFramesS @descr The Creator is the parent frame container. If it is NULL, the frame is the uppermost one. @seealso method setCreator() - - @param - @return A reference to current set parent frame container. @onerror A null reference is returned. @@ -996,8 +975,6 @@ css::uno::Reference< css::frame::XFramesSupplier > SAL_CALL Frame::getCreator() @descr This name is used to find target of findFrame() or queryDispatch() calls. @seealso method setName() - - @param - @return Current set name of frame. @onerror An empty string is returned. @@ -1018,8 +995,6 @@ OUString SAL_CALL Frame::getName() throw( css::uno::RuntimeException, std::excep @seealso method getName() @param "sName", new frame name. - @return - - @onerror We do nothing. *//*-*****************************************************************************************************/ void SAL_CALL Frame::setName( const OUString& sName ) throw( css::uno::RuntimeException, std::exception ) @@ -1300,7 +1275,6 @@ css::uno::Reference< css::frame::XFrame > SAL_CALL Frame::findFrame( const OUStr } /*-**************************************************************************************************** - @short - @descr Returns sal_True, if this frame is a "top frame", otherwise sal_False. The "m_bIsFrameTop" member must be set in the ctor or setCreator() method. A top frame is a member of the top frame container or a member of the @@ -1310,8 +1284,6 @@ css::uno::Reference< css::frame::XFrame > SAL_CALL Frame::findFrame( const OUStr @seealso ctor @seealso method setCreator() @seealso method findFrame() - - @param - @return true, if is it a top frame ... false otherwise. @onerror No error should occur! @@ -1337,11 +1309,7 @@ sal_Bool SAL_CALL Frame::isTop() throw( css::uno::RuntimeException, std::excepti @seealso method isActivate() @seealso enum EActiveState @seealso listener mechanism - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ void SAL_CALL Frame::activate() throw( css::uno::RuntimeException, std::exception ) { @@ -1427,11 +1395,7 @@ void SAL_CALL Frame::activate() throw( css::uno::RuntimeException, std::exceptio @seealso method isActivate() @seealso enum EActiveState @seealso listener mechanism - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ void SAL_CALL Frame::deactivate() throw( css::uno::RuntimeException, std::exception ) { @@ -1505,8 +1469,6 @@ void SAL_CALL Frame::deactivate() throw( css::uno::RuntimeException, std::except @seealso method activate() @seealso method deactivate() @seealso enum EActiveState - - @param - @return true if active, false otherwise. @onerror No error should occur. @@ -1526,14 +1488,8 @@ sal_Bool SAL_CALL Frame::isActive() throw( css::uno::RuntimeException, std::exce /*-**************************************************************************************************** @short ??? - @descr - - @seealso - - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ void SAL_CALL Frame::contextChanged() throw( css::uno::RuntimeException, std::exception ) { @@ -1727,8 +1683,6 @@ sal_Bool SAL_CALL Frame::setComponent( const css::uno::Reference< css::awt::X This frame is the owner of the component window. @seealso method setComponent() - - @param - @return css::uno::Reference to current set component window. @onerror A null reference is returned. @@ -1755,8 +1709,6 @@ css::uno::Reference< css::awt::XWindow > SAL_CALL Frame::getComponentWindow() th This frame is the owner of the component window. @seealso method setComponent() - - @param - @return css::uno::Reference to current set controller. @onerror A null reference is returned. @@ -1769,15 +1721,11 @@ css::uno::Reference< css::frame::XController > SAL_CALL Frame::getController() t /*-**************************************************************************************************** @short add/remove listener for activate/deactivate/contextChanged events - @descr - - @seealso method activate() @seealso method deactivate() @seealso method contextChanged() @param "xListener" reference to your listener object - @return - - @onerror Listener is ignored. *//*-*****************************************************************************************************/ void SAL_CALL Frame::addFrameActionListener( const css::uno::Reference< css::frame::XFrameActionListener >& xListener ) throw( css::uno::RuntimeException, std::exception ) @@ -2074,11 +2022,7 @@ void Frame::implts_forgetSubFrames() @seealso method initialize() @seealso baseclass FairRWLockBase! - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ void SAL_CALL Frame::dispose() throw( css::uno::RuntimeException, std::exception ) { @@ -2212,12 +2156,7 @@ void SAL_CALL Frame::dispose() throw( css::uno::RuntimeException, std::exception @short Be a listener for dispose events! @descr Adds/remove an EventListener to this object. If the dispose method is called on this object, the disposing method of the listener is called. - - @seealso - - @param "xListener" reference to your listener object. - @return - - @onerror Listener is ignored. *//*-*****************************************************************************************************/ void SAL_CALL Frame::addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) throw( css::uno::RuntimeException, std::exception ) @@ -2254,8 +2193,6 @@ void SAL_CALL Frame::removeEventListener( const css::uno::Reference< css::lang:: @seealso class StatusIndicatorFactory @seealso class StatusIndicator - - @param - @return A reference to created object. @onerror We return a null reference. @@ -2363,8 +2300,6 @@ css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL Fram @seealso class OInterceptionHelper @param "xInterceptor", reference to your interceptor implementation. - @return - - @onerror Interceptor is ignored. *//*-*****************************************************************************************************/ void SAL_CALL Frame::registerDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor ) throw( css::uno::RuntimeException, std::exception ) @@ -2417,8 +2352,6 @@ css::uno::Sequence< css::frame::DispatchInformation > SAL_CALL Frame::getConfigu @seealso member m_xComponentWindow @param "aEvent" describe source of detected event - @return - - @onerror - *//*-*****************************************************************************************************/ void SAL_CALL Frame::windowResized( const css::awt::WindowEvent& aEvent ) throw( css::uno::RuntimeException, std::exception ) @@ -2470,8 +2403,6 @@ void SAL_CALL Frame::focusGained( const css::awt::FocusEvent& aEvent ) throw( cs @seealso member m_xComponentWindow @param "aEvent" describe source of detected event - @return - - @onerror - *//*-*****************************************************************************************************/ void SAL_CALL Frame::windowActivated( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ) @@ -2666,11 +2597,7 @@ void SAL_CALL Frame::windowHidden( const css::lang::EventObject& ) throw(css::un @seealso XWindowListener @seealso XTopWindowListener @seealso XFocusListener - - @param - @return - - - @onerror - *//*-*****************************************************************************************************/ void SAL_CALL Frame::disposing( const css::lang::EventObject& aEvent ) throw( css::uno::RuntimeException, std::exception ) { @@ -2705,12 +2632,8 @@ void SAL_CALL Frame::disposing( const css::lang::EventObject& aEvent ) throw( cs @seealso interface XActionLockable @seeelso method BaseDispatcher::implts_loadIt() @seeelso method Desktop::loadComponentFromURL() - - @param - @return true if frame/task is locked false otherwise - - @onerror - @threadsafe yes *//*-*************************************************************************************************************/ sal_Bool SAL_CALL Frame::isActionLocked() throw( css::uno::RuntimeException, std::exception ) @@ -2918,13 +2841,8 @@ css::uno::Any SAL_CALL Frame::impl_getPropertyValue(const OUString& /*sProperty* /*-**************************************************************************************************** @short dispose old container window and forget his reference @descr Sometimes we must repair our "modal dialog parent mechanism" too! - - @seealso - - @param "xWindow", reference to old container window to dispose it @return An empty reference. - - @onerror - @threadsafe NO! *//*-*****************************************************************************************************/ void Frame::impl_disposeContainerWindow( css::uno::Reference< css::awt::XWindow >& xWindow ) @@ -2942,12 +2860,7 @@ void Frame::impl_disposeContainerWindow( css::uno::Reference< css::awt::XWindow /*-**************************************************************************************************** @short send frame action event to our listener @descr This method is threadsafe AND can be called by our dispose method too! - - @seealso - - @param "aAction", describe the event for sending - @return - - @onerror - *//*-*****************************************************************************************************/ void Frame::implts_sendFrameActionEvent( const css::frame::FrameAction& aAction ) @@ -3005,12 +2918,7 @@ void Frame::implts_sendFrameActionEvent( const css::frame::FrameAction& aAction @descr A frame contains 2 windows - a container ~ and a component window. This method resize inner component window to full size of outer container window. This method is threadsafe AND can be called by our dispose method too! - - @seealso - - @param - - @return - - @onerror - *//*-*****************************************************************************************************/ void Frame::implts_resizeComponentWindow() @@ -3043,8 +2951,6 @@ void Frame::implts_resizeComponentWindow() too ... we should ask his optional property set first ... @seealso method Window::SetIcon() - - @param - @return - @onerror We do nothing. @@ -3136,8 +3042,6 @@ void Frame::implts_setIconOnWindow() @seealso method initialize() @seealso method dispose() - - @param - @return - @onerror We do nothing! |