[prev in list] [next in list] [prev in thread] [next in thread]
List: koffice-devel
Subject: [patch] Minor API documentation changes
From: Brad Hards <bhards () bigpond ! net ! au>
Date: 2003-12-31 21:41:14
Message-ID: 200401010841.15072.bhards () bigpond ! net ! au
[Download RAW message or body]
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
The enclosed patch makes some little fixes to the koffice/libs API
documentation. Is this OK to apply?
Brad
- --
http://linux.conf.au - I'm registered. Are you?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (GNU/Linux)
iD8DBQE/80J6GwwszQ/PZzgRAh0PAJ9NoUxAkN3BUKp32wLIZnzhk4cUaQCdHdPD
U6U1AtXzWkqSGXcXPseygBw=
=Dt7X
-----END PGP SIGNATURE-----
["apidox-2004-01-01.patch" (text/x-diff)]
? Doxyfile
? apidox-2004-01-01.patch
Index: kformula/kformulacontainer.h
===================================================================
RCS file: /home/kde/koffice/lib/kformula/kformulacontainer.h,v
retrieving revision 1.82
diff -u -4 -p -r1.82 kformulacontainer.h
--- kformula/kformulacontainer.h 30 Jun 2003 22:13:17 -0000 1.82
+++ kformula/kformulacontainer.h 31 Dec 2003 21:43:47 -0000
@@ -199,9 +199,9 @@ public:
*/
bool load( QDomElement fe );
/**
- * @retruns a tex string for the formula
+ * @returns a tex string for the formula
*/
QString texString();
QString formulaString();
Index: kformula/kformulamathmlread.h
===================================================================
RCS file: /home/kde/koffice/lib/kformula/kformulamathmlread.h,v
retrieving revision 1.6
diff -u -4 -p -r1.6 kformulamathmlread.h
--- kformula/kformulamathmlread.h 10 Mar 2003 20:25:08 -0000 1.6
+++ kformula/kformulamathmlread.h 31 Dec 2003 21:43:47 -0000
@@ -43,11 +43,11 @@ class MathML2KFormula : public KFInputFi
public:
/**
* Build a MathML 2 KFormula converter.
- * call @startConversion to convert and wait for
- * a @conversionFinished signal, than call
- * @getKFormulaDom to get the converted DOM
+ * call \ref startConversion to convert and wait for
+ * a \ref conversionFinished signal, than call
+ * \ref getKFormulaDom to get the converted DOM
*/
MathML2KFormula( QDomDocument mmldoc, const ContextStyle &contextStyle );
/*
Index: kformula/sequenceparser.h
===================================================================
RCS file: /home/kde/koffice/lib/kformula/sequenceparser.h,v
retrieving revision 1.10
diff -u -4 -p -r1.10 sequenceparser.h
--- kformula/sequenceparser.h 1 May 2002 21:00:10 -0000 1.10
+++ kformula/sequenceparser.h 31 Dec 2003 21:43:47 -0000
@@ -57,9 +57,9 @@ public:
/**
* Tells the element about its new token.
*
* @param pos the position of the element
- * @param token the new token
+ * @param type the new token
*/
void setElementType(uint pos, ElementType* type);
/**
Index: kofficecore/koDocument.h
===================================================================
RCS file: /home/kde/koffice/lib/kofficecore/koDocument.h,v
retrieving revision 1.147
diff -u -4 -p -r1.147 koDocument.h
--- kofficecore/koDocument.h 8 Oct 2003 01:57:32 -0000 1.147
+++ kofficecore/koDocument.h 31 Dec 2003 21:43:47 -0000
@@ -65,16 +65,17 @@ public:
*
* @param parentWidget the parent widget, in case we create a wrapper widget
* (in single view mode).
* Usually the first argument passed by KParts::Factory::createPart.
+ * @param widgetName the name of the widget. Usually the second argument of \
KParts::Factory::createPart.
* @param parent may be another KoDocument, or anything else.
* Usually the third argument of KParts::Factory::createPart.
* @param name is used to identify this document via DCOP so you may want to
* pass a meaningful name here which matches the pattern \
[A-Za-z_][A-Za-z_0-9]*.
* @param singleViewMode determines whether the document may only have one view. \
In this case
* the @p parent must be a QWidget derived class. KoDocument will then \
create a wrapper widget
* (@ref KoViewWrapperWidget) which is a child of @p parentWidget.
- * This widget can be retrieved by calling @ref #widget.
+ * This widget can be retrieved by calling @ref widget.
*/
KoDocument( QWidget* parentWidget,
const char* widgetName,
QObject* parent,
@@ -84,9 +85,9 @@ public:
/**
* Destructor.
*
* The destructor does not delete any attached @ref KoView objects and it does \
not
- * delete the attached widget as returned by @ref #widget.
+ * delete the attached widget as returned by @ref widget.
*/
virtual ~KoDocument();
/**
@@ -101,9 +102,9 @@ public:
bool isEmbedded() const;
/**
* Returns the action described action object. In fact only the "name" attribute
- * of @ref #element is of interest here. The method searches first in the
+ * of @ref element is of interest here. The method searches first in the
* @ref KActionCollection of the first view and then in the KActionCollection of \
this
* document.
* This allows KOffice applications to define actions in both the view and the \
document.
* They should only define view-actions (like zooming and stuff) in the view.
@@ -328,9 +329,9 @@ public:
virtual void paintChild( KoDocumentChild *child, QPainter &painter, KoView \
*view, double zoomX = 1.0, double zoomY = 1.0 );
/**
- * Paints the data itself. Normally called by @ref paintEverthing. It does not
+ * Paints the data itself. Normally called by @ref paintEverything. It does not
* paint the children.
* It's this method that KOffice Parts have to implement.
*
* @param painter The painter object into that should be drawn.
@@ -397,8 +398,9 @@ public:
/**
* Loads a document from a store.
* You should never have to reimplement.
+ * @param store the KoStore to load from
* @param url An internal url, like tar:/1/2
*/
virtual bool loadFromStore( KoStore* store, const QString& url );
Index: kofficecore/koFilter.h
===================================================================
RCS file: /home/kde/koffice/lib/kofficecore/koFilter.h,v
retrieving revision 1.28
diff -u -4 -p -r1.28 koFilter.h
--- kofficecore/koFilter.h 11 Aug 2003 21:51:45 -0000 1.28
+++ kofficecore/koFilter.h 31 Dec 2003 21:43:48 -0000
@@ -132,10 +132,10 @@ private:
*
* If you're using this class you can also setup a signal/slot communication
* between parent and child filter. To make that work you simply have to define
* signals and slots along the following rules:
- * Signals should be named "commSignal<name>" where <name> is the name of the \
signal,
- * slots should be named "commSlot<name>". The connection will be done automatically
+ * Signals should be named "commSignal<name>" where <name> is the name of the \
signal, + * slots should be named "commSlot<name>". The connection will be done \
automatically
* if names and signatures are matching.
*
* @author Werner Trobin
*/
Index: kofficecore/koPictureCollection.h
===================================================================
RCS file: /home/kde/koffice/lib/kofficecore/koPictureCollection.h,v
retrieving revision 1.13
diff -u -4 -p -r1.13 koPictureCollection.h
--- kofficecore/koPictureCollection.h 1 Jul 2003 10:50:18 -0000 1.13
+++ kofficecore/koPictureCollection.h 31 Dec 2003 21:43:48 -0000
@@ -97,9 +97,9 @@ public:
*/
void saveToStoreAsKOffice1Dot1(const Type pictureType, KoStore * store, \
QValueList<KoPictureKey> keys );
/**
- * Generate the <PIXMAPS> or <CLIPARTS> tag, that saves the key and the related
+ * Generate the <PIXMAPS> or <CLIPARTS> tag, that saves the key and the \
related
* relative path in the store (e.g. pictures/picture1.png) for each picture.
*
* @param pictureType the type of the collection
* @param doc the DOM document in which the tags are to be generated
@@ -111,13 +111,13 @@ public:
void saveXMLAsKOffice1Dot1(QDomDocument &doc, QDomElement& parent, \
QValueList<KoPictureKey> keys);
typedef QMap<KoPictureKey, QString> StoreMap;
/**
- * Read the <PIXMAPS> or <CLIPARTS> tag, and save the result \
(key<->store-filename associations) + * Read the <PIXMAPS> or <CLIPARTS> \
tag, and save the result (key<->store-filename associations)
* into the QMap. You may want to 'new' a QMap in loadXML, and to use and then \
delete
* it in completeLoading (to save memory).
*
- * @param pixmapsElem the <PIXMAPS> or <CLIPARTS> element
+ * @param pixmapsElem the <PIXMAPS> or <CLIPARTS> element
*/
StoreMap readXML( QDomElement &pixmapsElem );
/**
@@ -137,9 +137,9 @@ public:
* KPresenter needs to use the same code for loading images from a collection \
and
* for loading images from disk.
*
* @param fileName the name of the file to read from disk if needed
- * @param the date and time
+ * @param dateTime the date and time
*
* Formerly, an invalid date/time meant to read the file from disk. This is not \
the case anymore.
*/
KoPicture findOrLoad(const QString& fileName, const QDateTime& dateTime);
Index: kofficeui/koTemplateChooseDia.h
===================================================================
RCS file: /home/kde/koffice/lib/kofficeui/koTemplateChooseDia.h,v
retrieving revision 1.46
diff -u -4 -p -r1.46 koTemplateChooseDia.h
--- kofficeui/koTemplateChooseDia.h 25 Aug 2003 20:05:42 -0000 1.46
+++ kofficeui/koTemplateChooseDia.h 31 Dec 2003 21:43:48 -0000
@@ -56,9 +56,11 @@ class KoTCDIconCanvas : public KIconCanv
KIconCanvas::keyPressEvent( e );
}
};
-/// @internal
+/**
+ * @internal
+ */
class KoTCDIconViewItem : public KIconViewItem
{
public:
KoTCDIconViewItem(QIconView *parent=0)
Index: kofficeui/kocommandhistory.h
===================================================================
RCS file: /home/kde/koffice/lib/kofficeui/kocommandhistory.h,v
retrieving revision 1.4
diff -u -4 -p -r1.4 kocommandhistory.h
--- kofficeui/kocommandhistory.h 1 Jul 2003 10:50:19 -0000 1.4
+++ kofficeui/kocommandhistory.h 31 Dec 2003 21:43:49 -0000
@@ -67,9 +67,10 @@ public:
* Creates a command history, to store commands.
* This also creates an undo and a redo action, in the @p actionCollection,
* using the standard names ("edit_undo" and "edit_redo").
*
- * @param withMenus if true, the actions will display a menu when plugged
+ * \param actionCollection the command history
+ * \param withMenus if true, the actions will display a menu when plugged
* into a toolbar.
*/
KoCommandHistory(KActionCollection *actionCollection, bool withMenus = true);
Index: koscript/koscript.h
===================================================================
RCS file: /home/kde/koffice/lib/koscript/koscript.h,v
retrieving revision 1.7
diff -u -4 -p -r1.7 koscript.h
--- koscript/koscript.h 1 Jul 2003 10:50:19 -0000 1.7
+++ koscript/koscript.h 31 Dec 2003 21:43:49 -0000
@@ -57,26 +57,29 @@ public:
*/
virtual ~KSInterpreter();
/**
- * Reads the script @p filename from the hard disk and tries to execute it.
+ * Reads a script from the hard disk and tries to execute it.
*
+ * @param filename the name of the file containing the script to be executed
* @param args is the list of parameters passed to the main function
*
* @return the stringified exception or an empty string if everything was ok.
* This is a convenience function for @ref #runModule.
*/
QString runScript( const QString& filename, const QStringList& args );
/**
- * Runs a module located in the file @p filename. The modules name is given by @p \
name.
- * Usually you may want to use @ref #runScript instead.
+ * Runs a module located in a file.
+ * Usually you may want to use @ref runScript instead.
*
* @param context contains the initialized module as value and
* the exception in case of an error. Once the value ( read: the module )
* of "context" is deleted, you may no longer use the exception contained
* in "context". That means you may not extract the exception and destroy
* the KSContext object and then still use the exception object.
+ * @param name is the name of the module to run
+ * @param filename is the name of the file the module is located in
* @param args is the list of parameters passed to the main function
*/
bool runModule( KSContext& context, const QString& name, const QString& filename, \
const QStringList& args );
@@ -179,9 +182,9 @@ protected:
* specified in the command line then this stream points to stdin.
*/
QTextStream* m_outStream;
/**
- * Used for @ref #m_stream
+ * Used for @ref m_stream
*/
QIODevice* m_outDevice;
/**
* The last line read by the <> operator is stored here.
Index: kotext/kospell.h
===================================================================
RCS file: /home/kde/koffice/lib/kotext/kospell.h,v
retrieving revision 1.4
diff -u -4 -p -r1.4 kospell.h
--- kotext/kospell.h 4 Dec 2003 13:12:59 -0000 1.4
+++ kotext/kospell.h 31 Dec 2003 21:43:49 -0000
@@ -86,15 +86,12 @@ public:
* Be sure to call @ref cleanUp() when you are done with KSpell.
*
* If KSpell could not be started correctly, @ref death() is emitted.
*
- * @param parent Parent of @ref KSpellConfig dialog..
- * @param caption Caption of @ref KSpellConfig dialog.
+ * @param parent Parent of @ref KSpellConfig dialog.
* @param receiver Receiver object for the ready(KSpell *) signal.
* @param slot Receiver's slot, will be connected to the ready(KSpell *) \
signal.
* @param kcs Configuration for KSpell.
- * @param progressbar Indicates if progress bar should be shown.
- * @param modal Indicates modal or non-modal dialog.
**/
KoSpell(QWidget *parent, QObject *receiver, const char *slot, KSpellConfig *kcs=0);
Index: kotext/kotextobject.h
===================================================================
RCS file: /home/kde/koffice/lib/kotext/kotextobject.h,v
retrieving revision 1.84
diff -u -4 -p -r1.84 kotextobject.h
--- kotext/kotextobject.h 18 Aug 2003 19:43:39 -0000 1.84
+++ kotext/kotextobject.h 31 Dec 2003 21:43:49 -0000
@@ -169,14 +169,15 @@ class KoTextObject : public QObject, pub
{
Q_OBJECT
public:
/** Constructor.
- * @param the zoom handler (to be passed to the KoTextDocument ctor)
+ * @param zh the zoom handler (to be passed to the KoTextDocument ctor)
* @param defaultFont the font to use by default (@see KoTextFormatCollection)
* @param defaultStyle the style to use by default (initial pararaph, and when \
deleting a used style)
* This constructor creates the contained KoTextDocument automatically.
*/
- KoTextObject( KoZoomHandler *zh, const QFont& defaultFont, const QString \
&defaultLanguage, bool hyphen, double ulw, KoStyle* defaultStyle,int _tabStopWidth = \
-1, + KoTextObject( KoZoomHandler *zh, const QFont& defaultFont, const QString \
&defaultLanguage, bool hyphen, + double ulw, KoStyle* defaultStyle,int \
_tabStopWidth = -1, QObject* parent = 0, const char *name = 0 );
/** Alternative constructor.
* @param textdoc the text document to use in this text object. Ownership is \
transferred @@ -221,10 +222,10 @@ public:
* @param cursor the insertion point
* @param currentFormat the current textformat, to apply to the inserted text
* @param text the text to be inserted
* @param checkNewLine if true, @p text is checked for '\n' (as a paragraph \
delimiter)
- * @param removeSelected whether to remove selected text before - deprecated, \
better
- * use @ref replaceSelectionCommand instead, to get a single undo/redo command
+ * @param removeSelected whether to remove selected text before - deprecated, it \
is better + * to use replaceSelectionCommand instead, to get a single undo/redo \
command
* @param commandName the name to give the undo/redo command if we haven't \
created it already
* @param customItemsMap the map of custom items to include in the new text
*/
void insert( KoTextCursor * cursor, KoTextFormat * currentFormat, const QString \
&text, @@ -236,8 +237,9 @@ public:
* Remove the text currently selected, including undo/redo creation/update.
* @param cursor the caret position
* @param selectionId which selection to remove (usually Standard)
* @param cmdName the name to give the undo/redo command, if we haven't created \
it already + * @param createUndoRedo if true, an undo/redo command will be \
created and emitted
*/
void removeSelectedText( KoTextCursor * cursor, int selectionId = \
KoTextDocument::Standard,
const QString & cmdName = QString::null, bool \
createUndoRedo=true );
@@ -314,10 +316,9 @@ public:
/** Update the paragraph that use the given style, after this style was changed.
* The flags tell which changes should be applied.
- * @param paragLayoutChanged paragraph flags
- * @param formatChanged format flags
+ * @param changed format flags
*/
void applyStyleChange( StyleChangeDefMap changed );
/** Set format changes on selection or current cursor.
Creates a command if the format was applied to a selection */
@@ -459,9 +460,9 @@ public: // made public for KWTextFrameSe
/** This prepares undoRedoInfo for a paragraph formatting change
* If this does too much, we could pass an enum flag to it.
* But the main point is to avoid too much duplicated code */
void storeParagUndoRedoInfo( KoTextCursor * cursor, int selectionId = \
KoTextDocument::Standard );
- /** Copies a formatted char, <parag, position>, into undoRedoInfo.text, at \
position <index>. */ + /** Copies a formatted char, <parag, position>, into \
undoRedoInfo.text, at position <index>. */
void copyCharFormatting( KoTextParag *parag, int position, int index /*in \
text*/, bool moveCustomItems );
void readFormats( KoTextCursor &c1, KoTextCursor &c2, bool copyParagLayouts = \
false, bool moveCustomItems = false );
/**
Index: kotext/kovariable.h
===================================================================
RCS file: /home/kde/koffice/lib/kotext/kovariable.h,v
retrieving revision 1.58
diff -u -4 -p -r1.58 kovariable.h
--- kotext/kovariable.h 22 Aug 2003 22:37:56 -0000 1.58
+++ kotext/kovariable.h 31 Dec 2003 21:43:49 -0000
@@ -161,15 +161,21 @@ public:
/// Set the format string (e.g. DDMMYYYY)
virtual void setFormatProperties( const QString& props ) {
m_strFormat = props;
}
- /// @return the format string (e.g. DDMMYYYY)
+ /**
+ * @return the format string (e.g. DDMMYYYY)
+ */
virtual QString formatProperties() const { return m_strFormat; }
- /// @return the list of available format strings
+ /**
+ * @return the list of available format strings
+ */
virtual QStringList formatPropsList() const { return staticFormatPropsList(); }
- /// @return the translated version of the list of formats
+ /**
+ * @return the translated version of the list of formats
+ */
virtual QStringList translatedFormatPropsList() const { return \
staticTranslatedFormatPropsList(); }
static QStringList staticFormatPropsList();
static QStringList staticTranslatedFormatPropsList();
@@ -193,15 +199,21 @@ public:
/// Set the format string (e.g. hh:mm:ss)
virtual void setFormatProperties( const QString& props ) {
m_strFormat = props;
}
- /// @return the format string (e.g. hh:mm:ss)
+ /**
+ * @return the format string (e.g. hh:mm:ss)
+ */
virtual QString formatProperties() const { return m_strFormat; }
- /// @return the list of available properties strings (e.g. hh:mm:ss)
+ /**
+ * @return the list of available properties strings (e.g. hh:mm:ss)
+ */
virtual QStringList formatPropsList() const { return staticFormatPropsList(); }
- /// @return the translated version of the list of format properties
+ /**
+ * @return the translated version of the list of format properties
+ */
virtual QStringList translatedFormatPropsList() const { return \
staticTranslatedFormatPropsList(); }
static QStringList staticFormatPropsList();
static QStringList staticTranslatedFormatPropsList();
Index: store/koStore.h
===================================================================
RCS file: /home/kde/koffice/lib/store/koStore.h,v
retrieving revision 1.42
diff -u -4 -p -r1.42 koStore.h
--- store/koStore.h 1 Jul 2003 10:50:20 -0000 1.42
+++ store/koStore.h 31 Dec 2003 21:43:49 -0000
@@ -95,9 +95,9 @@ public:
/**
* Read data from the currently opened file. You can also use the streams
* for this.
*/
- QByteArray read( long unsigned int max );
+ QByteArray read( unsigned long int max );
/**
* Write data into the currently opened file. You can also use the streams
* for this.
_______________________________________________
koffice-devel mailing list
koffice-devel@mail.kde.org
https://mail.kde.org/mailman/listinfo/koffice-devel
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic