office/okular
office/okular
1
0
Fork 0
mirror of https://invent.kde.org/graphics/okular synced 2024-07-17 02:37:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix minor API docs EBN issues

Browse source
This commit is contained in:
Yuri Chornoivan 2018-10-19 09:00:06 +03:00
parent 2f014ccd20
commit 69c7b834d1
8 changed files with 30 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
core/action.h
View file

@ -406,6 +406,7 @@ class OKULARCORE_EXPORT ScriptAction : public Action
/**
* Creates a new Script action.
*
* @param type The type of the script (for now, only JavaScript = 0 is implemented).
* @param script The code to execute.
*/
ScriptAction( enum ScriptType type, const QString &script );

28
core/document.h
View file

@ -420,6 +420,7 @@ class OKULARCORE_EXPORT Document : public QObject
/**
* Sets the current document viewport to the given @p page.
*
* @param page The number of the page.
* @param excludeObserver The observer ids which shouldn't be effected by this change.
* @param smoothMove Whether the move shall be animated smoothly.
*/
@ -428,6 +429,7 @@ class OKULARCORE_EXPORT Document : public QObject
/**
* Sets the current document viewport to the given @p viewport.
*
* @param viewport The document viewport.
* @param excludeObserver The observer which shouldn't be effected by this change.
* @param smoothMove Whether the move shall be animated smoothly.
*/
@ -482,6 +484,7 @@ class OKULARCORE_EXPORT Document : public QObject
/**
* Sends @p requests for pixmap generation.
*
* @param requests the linked list of requests
* @param reqOptions the options for the request
*
* @since 0.7 (KDE 4.1)
@ -580,6 +583,7 @@ class OKULARCORE_EXPORT Document : public QObject
/**
* Sets the text selection for the given @p page.
*
* @param page The number of the page.
* @param rect The rectangle of the selection.
* @param color The color of the selection.
*/
@ -625,6 +629,7 @@ class OKULARCORE_EXPORT Document : public QObject
* Searches the given @p text in the document.
*
* @param searchID The unique id for this search request.
* @param text The text to be searched.
* @param fromStart Whether the search should be started at begin of the document.
* @param caseSensitivity Whether the search is case sensitive.
* @param type The type of the search. @ref SearchType
@ -1115,6 +1120,9 @@ class OKULARCORE_EXPORT Document : public QObject
* This signal is emitted whenever a source reference with the given parameters has been
* activated.
*
* \param absFileName absolute name of the file.
* \param line line number.
* \param col column number.
* \param handled should be set to 'true' if a slot handles this source reference; the
* default action to launch the configured editor will then not be performed
* by the document
@ -1129,19 +1137,19 @@ class OKULARCORE_EXPORT Document : public QObject
void processMovieAction( const Okular::MovieAction *action );
/**
* This signal is emmitted whenever the availability of the undo function changes
* This signal is emitted whenever the availability of the undo function changes
* @since 0.17 (KDE 4.11)
*/
void canUndoChanged( bool undoAvailable );
/**
* This signal is emmitted whenever the availability of the redo function changes
* This signal is emitted whenever the availability of the redo function changes
* @since 0.17 (KDE 4.11)
*/
void canRedoChanged( bool redoAvailable );
/**
* This signal is emmitted whenever the undo history is clean (i.e. the same status the last time it was saved)
* This signal is emitted whenever the undo history is clean (i.e. the same status the last time it was saved)
* @since 1.3
*/
void undoHistoryCleanChanged( bool clean );
@ -1154,7 +1162,7 @@ class OKULARCORE_EXPORT Document : public QObject
void processRenditionAction( const Okular::RenditionAction *action );
/**
* This signal is emmitted whenever the contents of the given @p annotation are changed by an undo
* This signal is emitted whenever the contents of the given @p annotation are changed by an undo
* or redo action.
*
* The new contents (@p contents), cursor position (@p cursorPos), and anchor position (@p anchorPos) are
@ -1164,7 +1172,7 @@ class OKULARCORE_EXPORT Document : public QObject
void annotationContentsChangedByUndoRedo( Okular::Annotation* annotation, const QString & contents, int cursorPos, int anchorPos );
/**
* This signal is emmitted whenever the text contents of the given text @p form on the given @p page
* This signal is emitted whenever the text contents of the given text @p form on the given @p page
* are changed by an undo or redo action.
*
* The new text contents (@p contents), cursor position (@p cursorPos), and anchor position (@p anchorPos) are
@ -1174,28 +1182,28 @@ class OKULARCORE_EXPORT Document : public QObject
void formTextChangedByUndoRedo( int page, Okular::FormFieldText* form, const QString & contents, int cursorPos, int anchorPos );
/**
* This signal is emmitted whenever the selected @p choices for the given list @p form on the
* This signal is emitted whenever the selected @p choices for the given list @p form on the
* given @p page are changed by an undo or redo action.
* @since 0.17 (KDE 4.11)
*/
void formListChangedByUndoRedo( int page, Okular::FormFieldChoice* form, const QList< int > & choices );
/**
* This signal is emmitted whenever the active @p text for the given combo @p form on the
* This signal is emitted whenever the active @p text for the given combo @p form on the
* given @p page is changed by an undo or redo action.
* @since 0.17 (KDE 4.11)
*/
void formComboChangedByUndoRedo( int page, Okular::FormFieldChoice* form, const QString & text, int cursorPos, int anchorPos );
/**
* This signal is emmitted whenever the state of the specified group of form buttons (@p formButtons) on the
* This signal is emitted whenever the state of the specified group of form buttons (@p formButtons) on the
* given @p page is changed by an undo or redo action.
* @since 0.17 (KDE 4.11)
*/
void formButtonsChangedByUndoRedo( int page, const QList< Okular::FormFieldButton* > & formButtons );
/**
* This signal is emmitted whenever a FormField was changed programatically and the
* This signal is emitted whenever a FormField was changed programmatically and the
* according widget should be updated.
* @since 1.4
*/
@ -1293,7 +1301,7 @@ class OKULARCORE_EXPORT DocumentViewport
} rePos;
/**
* If 'autoFit.enabled == true' then the page must be autofitted in the viewport.
* If 'autoFit.enabled == true' then the page must be autofit in the viewport.
*/
struct {
bool enabled;

6
core/synctex/synctex_parser.h
View file

@ -75,7 +75,7 @@ extern "C" {
* to the synctex file.
* If necessary, it can be the tex file that
* originated the synctex file but this might cause
* problems if the \jobname has a custom value.
* problems if the \\jobname has a custom value.
* Despite this method can accept a relative path
* in practice, you should only pass full paths.
* The path should be encoded by the underlying
@ -231,7 +231,7 @@ extern "C" {
* );
* The visible dimensions are bigger than real ones
* to compensate 0 width boxes or nodes intentionnaly
* put outside the box (using \kern for example).
* put outside the box (using \\kern for example).
* - parameter node: a node.
* - returns: a float.
* - author: JL
@ -249,7 +249,7 @@ extern "C" {
* The origin is at the top left corner of the page.
* The visible dimensions are bigger than real ones
* to compensate 0 width boxes or nodes intentionnaly
* put outside the box (using \kern for example).
* put outside the box (using \\kern for example).
* All nodes have coordinates, but all nodes don't
* have non null size. For example, math nodes
* have no width according to TeX, and in that case

5
core/textdocumentgenerator.h
View file

@ -163,7 +163,10 @@ class OKULARCORE_EXPORT TextDocumentGenerator : public Generator, public Okular:
/**
* Creates a new generator that uses the specified @p converter.
*
* @param converter The text document converter.
* @param configName - see Okular::TextDocumentSettings
* @param parent The parent object.
* @param args The arguments.
*
* @note the generator will take ownership of the converter, so you
* don't have to delete it yourself
@ -197,7 +200,7 @@ class OKULARCORE_EXPORT TextDocumentGenerator : public Generator, public Okular:
* Config skeleton for TextDocumentSettingsWidget
*
* You must use new construtor to initialize TextDocumentSettings,
* that contain @param configName.
* that contain @p configName .
*
* @since 0.17 (KDE 4.11)
*/

1
core/tilesmanager_p.h
View file

@ -131,6 +131,7 @@ class TilesManager
* As to avoid requests of big areas, each traversed tile is checked
* for its size and split if necessary.
*
* @param rect The normalized rectangular area
* @param tileLeaf Indicate the type of tile to return
*/
QList<Tile> tilesAt( const NormalizedRect &rect, TileLeaf tileLeaf );

1
generators/dvi/dviexport.h
View file

@ -118,6 +118,7 @@ public:
* passed to the external process's argv command line.
* @param printer having generated the PostScript file, it is passed
* to @c printer (if not null).
* @param useFontHinting boolean that defines whether to use font hinting.
* @param orientation the original orientation of the document
*/
DVIExportToPS(dviRenderer& parent,

2
generators/dvi/length.h
View file

@ -79,7 +79,7 @@ class Length
/** sets the length in scaled points (1 scaled point = 65536 TeX points) */
void setLength_in_scaledPoints(double l) {length_in_mm = l*mm_per_scaledPoint;}
/** sets the length in pixel. The parameter @param res is the resolution of the
/** sets the length (@param l ) in pixels. The parameter @param res is the resolution of the
used device in DPI. */
void setLength_in_pixel(int l, double res) { setLength_in_inch(l / res); }

1
generators/fax/faxdocument.h
View file

@ -31,6 +31,7 @@ class FaxDocument
/**
* Creates a new fax document from the given @p fileName.
*
* @param fileName The name of the fax file.
* @param type The type of the fax document.
*/
explicit FaxDocument( const QString &fileName, DocumentType type = G3 );