Commit 515cabb3 authored by Stephan Kulow's avatar Stephan Kulow
Browse files

little cleanup. Removed all the @ref blah and @ref #foo - doxygen finds itself

if it's a reference to an existant class/namespace/function.

svn path=/trunk/kdelibs/; revision=243163
parent cf1d2777
......@@ -44,7 +44,7 @@ class KAudioRecordStream : public QObject
~KAudioRecordStream();
/**
* You can read @p size number of bytes. If @ref blockingIO() is set the method
* You can read @p size number of bytes. If blockingIO() is set the method
* will return as soon as it has all your data and could possibly block your
* program. The method returns the number of bytes that are actually in the
* buffer.
......@@ -69,12 +69,12 @@ class KAudioRecordStream : public QObject
bool blockingIO() const;
/**
* If you want to poll for data using @ref read() set this to true. If
* you'd rather not poll use the @ref data() signal for asynchronous
* I/O. If you set polling to true and don't call @ref read() or
* @ref flush() the inputbuffer will grow endlessly.
* If you want to poll for data using read() set this to true. If
* you'd rather not poll use the data() signal for asynchronous
* I/O. If you set polling to true and don't call read() or
* flush() the inputbuffer will grow endlessly.
*
* The default is false (if you want to use @ref read() set this to true).
* The default is false (if you want to use read() set this to true).
*/
void usePolling( bool );
......@@ -100,7 +100,7 @@ class KAudioRecordStream : public QObject
/**
* Attach to the soundserver and start getting data to read. This method
* must be called as soon as you want to receive data. In any case you have
* to call start() before @ref read()
* to call start() before read()
*
* @param samplingRate The sampling rate the stream should be resampled to. Use
* a number between 500 and 2000000.
......
......@@ -40,18 +40,18 @@ typedef QValueList<QCString> QCStringList;
* for KDE applications.
*
* This class provides IPC and RPC for KDE applications. Usually you
* will not have to instantiate one yourself because @ref KApplication
* will not have to instantiate one yourself because KApplication
* contains a method to return a pointer to a DCOPClient object which
* can be used for your whole application.
*
* Before being able to send or receive any DCOP messages, you will have
* to attach your client object to the DCOP server, and then register
* your application with a specific name. See @ref attach()
* and @ref registerAs() for
* your application with a specific name. See attach()
* and registerAs() for
* more information.
*
* Data to be sent should be serialized into a @ref QDataStream which was
* initialized with the @ref QByteArray that you actually intend to send
* Data to be sent should be serialized into a QDataStream which was
* initialized with the QByteArray that you actually intend to send
* the data in. An example of how you might do this:
*
* \code
......@@ -109,9 +109,9 @@ class DCOPClient : public QObject
/**
* @internal
* Internal function for @ref KUniqueApplication to register the @ref DCOPClient
* Internal function for KUniqueApplication to register the DCOPClient
* with the application in case the application didn't exist at the
* time the @ref DCOPClient was created.
* time the DCOPClient was created.
*/
void bindToApp();
......@@ -169,7 +169,7 @@ class DCOPClient : public QObject
* Registers at the DCOP server.
*
* If the application was already registered,
* the registration will be re-done with the new @ref appId.
* the registration will be re-done with the new appId.
*
* @p appId is a @p unique application/program id that the server
* will use to associate requests with. If there is already an application
......@@ -179,9 +179,9 @@ class DCOPClient : public QObject
*
* Registration is necessary if you want to allow other clients to talk
* to you. They can do so using your @p appId as first parameter
* for @ref send() or @ref call(). If you just want to talk to
* for send() or call(). If you just want to talk to
* other clients, you
* do not need to register at the server. In that case @ref attach() is
* do not need to register at the server. In that case attach() is
* enough.
* It will implicitly register you as "anonymous".
*
......@@ -255,7 +255,7 @@ class DCOPClient : public QObject
/**
* This function acts exactly the same as the above, but the data
* parameter can be specified as a @ref QString for convenience.
* parameter can be specified as a QString for convenience.
*
* @param remApp The remote application id.
* @param remObj The name of the remote object.
......@@ -271,7 +271,7 @@ class DCOPClient : public QObject
* Performs a synchronous send and receive.
*
* The parameters are the same as for send, with the exception of
* another @ref QByteArray being provided for results to be
* another QByteArray being provided for results to be
* (optionally) returned in.
*
* A call blocks the application until the process receives the
......@@ -466,10 +466,10 @@ class DCOPClient : public QObject
/**
* Reimplement this function to handle app-wide function calls unassociated w/an object.
*
* Note that @p fun is normalized. See @ref normalizeFunctionSignature().
* Note that @p fun is normalized. See normalizeFunctionSignature().
*
* If you do not want to reimplement this function for whatever reason,
* you can also use a default object or a @ref DCOPObjectProxy.
* you can also use a default object or a DCOPObjectProxy.
*
* @param fun the normalized function signature
* @param data the received data
......@@ -483,18 +483,18 @@ class DCOPClient : public QObject
/**
* Delays the reply of the current function call
* until @ref endTransaction() is called.
* until endTransaction() is called.
*
* This allows a server to queue requests.
*
* Note: Should be called from inside @ref process() only!
* Note: Should be called from inside process() only!
* @see endTransaction()
*/
DCOPClientTransaction *beginTransaction( );
/**
* Sends the delayed reply of a function call.
* @param t the transaction as received from @ref beginTransaction()
* @param t the transaction as received from beginTransaction()
* @param replyType write the reply type in this string
* @param replyData write the reply data in this array
* @see beginTransaction()
......@@ -504,7 +504,7 @@ class DCOPClient : public QObject
/**
* Test whether the current function call is delayed.
*
* Note: Should be called from inside @ref process() only!
* Note: Should be called from inside process() only!
* @return The ID of the current transaction or
* 0 if no transaction is going on.
* @see process()
......@@ -599,7 +599,7 @@ class DCOPClient : public QObject
* "someFunction(QString,int)"
* \endcode
*
* When using @ref send() or @ref call(), normalization is done
* When using send() or call(), normalization is done
* automatically for you.
*
* @param fun the function signature to normalize
......@@ -636,8 +636,8 @@ class DCOPClient : public QObject
QCString defaultObject() const;
/**
* Enables / disables the @ref applicationRegistered() /
* @ref applicationRemoved() signals.
* Enables / disables the applicationRegistered() /
* applicationRemoved() signals.
* Note that a counter is maintained about how often this method
* was called. If this method is called twice with @p enabled set to
* true, notifications will be enabled until it was called with
......@@ -717,7 +717,7 @@ signals:
* Indicates that the application @p appId has been registered with
* the server we are attached to.
*
* You need to call @ref setNotifications() first, to tell the DCOP server
* You need to call setNotifications() first, to tell the DCOP server
* that you want to get these events.
* @param appId the id of the new application
*/
......@@ -726,7 +726,7 @@ signals:
* Indicates that the formerly registered application @p appId has
* been removed.
*
* You need to call @ref setNotifications() first, to tell the
* You need to call setNotifications() first, to tell the
* DCOP server that you want to get these events.
* @param appId the id of the removed application
*/
......@@ -751,7 +751,7 @@ signals:
* synchronous call. In that case, it will enter a local event
* loop to keep the GUI updated until finally an answer arrives.
*
* In KDE, the @ref KApplication object connects to this signal to be
* In KDE, the KApplication object connects to this signal to be
* able to block any user input (i.e. mouse and key events) while
* we are waiting for an answer. If we did not do this, the
* application might end up in an illegal state, as a keyboard
......
......@@ -20,7 +20,7 @@ class Test3;
/**
* This is a stupid comment that might help
* geiseri at some point in the near future.
* @ref blah di blah
* blah di blah
**/
class Test : public MyNamespace::MyParentClass, virtual public DCOPObject,
public QValueList<QString>
......
......@@ -51,7 +51,7 @@ private:
*
* This class provides an interface for receiving DCOP messages. To use it,
* simply multiply-inherit from DCOPObject and from some other class, and
* then implement the @ref DCOPObject::process() method. Because this method is
* then implement the DCOPObject::process() method. Because this method is
* pure virtual, you must implement the method.
*
* Note that it is usually more convenient to mark a section in the class with
......@@ -72,7 +72,7 @@ public:
DCOPObject();
/**
* Creates a DCOPObject and calculates the object id
* using @ref QObject::name().
* using QObject::name().
* @param obj the object to extract the name from
*/
DCOPObject(QObject *obj);
......@@ -108,7 +108,7 @@ public:
* compiler to automatically generate an implementation for
* this function.
*
* If this function returns false, then @ref processDynamic()
* If this function returns false, then processDynamic()
* is called.
*
* Note to implementators: remember to call the baseclasses
......@@ -138,7 +138,7 @@ public:
/**
* This function is of interest when you used an IDL compiler
* to generate the implementation for @ref process() but
* to generate the implementation for process() but
* you still want to dispatch some functions dynamically.
* Dynamically means that methods may appear and vanish
* during runtime.
......@@ -163,7 +163,7 @@ public:
/**
* This function is of interest when you used an IDL compiler
* to generate the implementation for @ref functions() but
* to generate the implementation for functions() but
* you still want to list some functions dynamically.
* Dynamically means that the methods may appear and vanish
* during runtime.
......@@ -176,7 +176,7 @@ public:
/**
* This function is of interest when you used an IDL compiler
* to generate the implementation for @ref interfaces() but
* to generate the implementation for interfaces() but
* you still want to list some interfaces dynamically.
* Dynamically means that they may appear and vanish
* during runtime.
......@@ -272,7 +272,7 @@ public:
const QCString &slot);
/**
* Returns the @ref DCOPClient responsible for making the call.
* Returns the DCOPClient responsible for making the call.
* Only call this function while you are handling a DCOP call.
* @return the DCOPClient responsible for making the call.
* This information is only guaranteed to be correct when
......@@ -282,7 +282,7 @@ public:
DCOPClient *callingDcopClient();
/**
* @internal Sets DCOPClient returned by @ref callingDcopClient()
* @internal Sets DCOPClient returned by callingDcopClient()
* @since 3.1
*/
void setCallingDcopClient(DCOPClient *);
......@@ -292,13 +292,13 @@ public:
* @return true if an object with the questionable @p objId is
* known in this process. This query does not ask proxies.
*
* @ref DCOPObjectProxy
* DCOPObjectProxy
*/
static bool hasObject(const QCString &objId);
/**
* Try to find a dcop object with the given id.
* This function does not query the @ref DCOPObjectProxy.
* This function does not query the DCOPObjectProxy.
* @param objId the object id to search
* @return the DCOPObject for the id @p objId.
*/
......@@ -318,7 +318,7 @@ public:
/**
* Creates an object id for the QObject @p obj. This is done
* using the @ref QObject::name() function.
* using the QObject::name() function.
* @param obj the object whose name will be used
* @return the created object id
*/
......@@ -340,7 +340,7 @@ private:
class DCOPObjectProxyPrivate;
/**
* You must use a proxy if you want to dispatch method calls for
* object IDs which dont have (yet) a corresponding @ref DCOPObject.
* object IDs which dont have (yet) a corresponding DCOPObject.
* This is somewhat like virtual object references in CORBA.
*
* @see DCOPObject
......@@ -371,9 +371,9 @@ public:
/**
* Reimplement this method to dispatch method calls.
*
* This method is called of all proxies if the @ref DCOPClient
* This method is called of all proxies if the DCOPClient
* knows no object with the id @p obj. If the first proxy returns
* @p true, the @ref DCOPClient will no longer call other proxies.
* @p true, the DCOPClient will no longer call other proxies.
*
* The object id @p obj may be empty for app-wide function calls no
* associated with any object.
......
This diff is collapsed.
......@@ -39,7 +39,7 @@ namespace KMediaPlayer
*
* There are two servicetypes for Player: KMediaPlayer/Player and
* KMediaPlayer/Engine. KMediaPlayer/Player provides a widget (accessable
* through @ref view as well as XML GUI KActions. KMediaPlayer/Engine omits
* through view as well as XML GUI KActions. KMediaPlayer/Engine omits
* the user interface facets, for those who wish to provide their own
* interface.
*/
......@@ -60,7 +60,7 @@ public:
virtual ~Player(void);
/** A convenience function returning a pointer to the @ref View for this
/** A convenience function returning a pointer to the View for this
* Player, or 0 if this Player has no GUI.
*/
virtual View *view(void) = 0;
......
......@@ -57,8 +57,8 @@ class QString;
virtual void progress( int percent ) =0;
/**
* This function will allow feedback on completion of the script.
* It turns the result as a @ref KScriptInteface::Result, and a return
* value as a @ref QVariant
* It turns the result as a KScriptInteface::Result, and a return
* value as a QVariant
*/
virtual void done( KScriptClientInterface::Result result, const QVariant &returned ) =0;
/**
......
......@@ -60,7 +60,7 @@ class ScriptInfo;
bool removeScript( const QString &scriptName );
/**
* Access the names of script instances from the script engine.
* @returns a @ref QStringList of the current scripts.
* @returns a QStringList of the current scripts.
*/
QStringList scripts();
/**
......@@ -91,8 +91,8 @@ class ScriptInfo;
void progress( int percent ) {emit scriptProgress(percent);}
/**
* This function will allow feedback on completion of the script.
* It turns the result as a @ref KScriptInteface::Result, and a return
* value as a @ref QVariant
* It turns the result as a KScriptInteface::Result, and a return
* value as a QVariant
*/
void done( KScriptClientInterface::Result result, const QVariant &returned ) {emit scriptDone(result, returned);}
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class BlockSelectionInterface;
/**
This is the main interface to the @ref BlockSelectionInterface of KTextEditor.
This is the main interface to the BlockSelectionInterface of KTextEditor.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref BlockSelectionInterface.
@short DCOP interface to BlockSelectionInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
class BlockSelectionDCOPInterface : virtual public DCOPObject
......@@ -22,7 +22,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref BlockSelectionInterface object
@param Parent the parent BlockSelectionInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class ClipboardInterface;
/**
This is the main interface to the @ref ClipboardInterface of KTextEdit.
This is the main interface to the ClipboardInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref ClipboardInterface.
@short DCOP interface to ClipboardInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
class ClipboardDCOPInterface : virtual public DCOPObject
......@@ -22,7 +22,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref ClipboardInterface object
@param Parent the parent ClipboardInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......
......@@ -33,7 +33,7 @@ namespace KTextEditor
* inserted text if a completion takes place. <code>comment</code> appears in a tooltip right of
* the completion list for the currently selected item. <code>userdata</code> can be
* free formed data, which the user of this interface can use in
* @ref CodeCompletionInterface::filterInsertString().
* CodeCompletionInterface::filterInsertString().
*
*
*/
......@@ -59,7 +59,7 @@ class CompletionEntry
};
/**
* This is an interface for the @ref KTextEditor::View class. It can be used
* This is an interface for the KTextEditor::View class. It can be used
* to show completion lists, i.e. lists that pop up while a user is typing.
* The user can then choose from the list or he can just keep typing. The
* completion list will disappear if an item is chosen, if no completion
......@@ -144,7 +144,7 @@ class CodeCompletionInterface
virtual void completionDone()=0;
/**
* This signal is the same as @ref completionDone(), but additionally it carries
* This signal is the same as completionDone(), but additionally it carries
* the information which completion item was used.
*
* IMPORTANT: Please check if a connect to this signal worked, and implement some fallback
......@@ -173,7 +173,7 @@ class CodeCompletionInterface
/**
* This signal is emitted just before a completion takes place.
* You can use it to modify the @ref CompletionEntry. The modified
* You can use it to modify the CompletionEntry. The modified
* entry will not be visible in the completion list (because that has
* just disappeared) but it will be used when the completion is
* inserted into the text.
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class DocumentInfoInterface;
/**
This is the main interface to the @ref DocumentInfoInterface of KTextEdit.
This is the main interface to the DocumentInfoInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref DocumentInfoInterface.
@short DCOP interface to DocumentInfoInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
......@@ -23,7 +23,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref DocumentInfoInterface object
@param Parent the parent DocumentInfoInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class EditInterface;
/**
This is the main interface to the @ref EditInterface of KTextEdit.
This is the main interface to the EditInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref EditInterface.
@short DCOP interface to EditInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
class EditDCOPInterface : virtual public DCOPObject
......@@ -22,7 +22,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref EditInterface object
@param Parent the parent EditInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class EncodingInterface;
/**
This is the main interface to the @ref EncodingInterface of KTextEdit.
This is the main interface to the EncodingInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref EncodingInterface.
@short DCOP interface to EncodingInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
class EncodingDCOPInterface : virtual public DCOPObject
......@@ -22,7 +22,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref EncodingInterface object
@param Parent the parent EncodingInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class PrintInterface;
/**
This is the main interface to the @ref PrintInterface of KTextEdit.
This is the main interface to the PrintInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref PrintInterface.
@short DCOP interface to PrintInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
class PrintDCOPInterface : virtual public DCOPObject
......@@ -22,7 +22,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref PrintInterface object
@param Parent the parent PrintInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class SearchInterface;
/**
This is the main interface to the @ref SearchInterface of KTextEdit.
This is the main interface to the SearchInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref SearchInterface.
@short DCOP interface to SearchInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
class SearchDCOPInterface : virtual public DCOPObject
......@@ -22,7 +22,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref SearchInterface object
@param Parent the parent SearchInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class SelectionInterface;
/**
This is the main interface to the @ref SelectionInterface of KTextEdit.
This is the main interface to the SelectionInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref SelectionInterface.
@short DCOP interface to SelectionInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
class SelectionDCOPInterface : virtual public DCOPObject
......@@ -22,7 +22,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref SelectionInterface object
@param Parent the parent SelectionInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......
......@@ -30,7 +30,7 @@
namespace KTextEditor {
/**
DCOP interface for the @ref SelectionInterfaceExt.
DCOP interface for the SelectionInterfaceExt.
@author Anders Lund <anders@alweb.dk>
*/
class SelectionExtDCOPInterface : virtual public DCOPObject
......
......@@ -26,7 +26,7 @@ namespace KTextEditor
{
/**
* This is an interface for the @ref KTextEditor::View class.
* This is an interface for the KTextEditor::View class.
*/
class TextHintInterface
......
......@@ -10,9 +10,9 @@ namespace KTextEditor
{
class UndoInterface;
/**
This is the main interface to the @ref UndoInterface of KTextEdit.
This is the main interface to the UndoInterface of KTextEdit.
This will provide a consistant dcop interface to all KDE applications that use it.
@short DCOP interface to @ref UndoInterface.
@short DCOP interface to UndoInterface.
@author Ian Reinhart Geiser <geiseri@kde.org>
*/
class UndoDCOPInterface : virtual public DCOPObject
......@@ -22,7 +22,7 @@ namespace KTextEditor
public:
/**
Construct a new interface object for the text editor.
@param Parent the parent @ref UndoInterface object
@param Parent the parent UndoInterface object
that will provide us with the functions for the interface.
@param name the QObject's name
*/
......