Commit c1dc7648 authored by Pino Toscano's avatar Pino Toscano

DOX: slightly improve apidox generation

SVN_SILENT


svn path=/trunk/playground/graphics/okular/; revision=623061
parent 2fe0e8e9
......@@ -219,13 +219,13 @@ class OKULAR_EXPORT Annotation
/**
* Sets the @p flags of the annotation.
* @see Flags
* @see @ref Flags
*/
void setFlags( int flags );
/**
* Returns the flags of the annotation.
* @see Flags
* @see @ref Flags
*/
int flags() const;
......
......@@ -182,7 +182,7 @@ class OKULAR_EXPORT Document : public QObject
/**
* Returns whether the given @p actions are allowed
* in the document.
* @see Permissions
* @see @ref Permissions
*/
bool isAllowed( Permissions actions ) const;
......@@ -358,7 +358,7 @@ class OKULAR_EXPORT Document : public QObject
* @param searchID The unique id for this search request.
* @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. @see SearchType
* @param type The type of the search. @ref SearchType
* @param moveViewport Whether the viewport shall be moved to the position of the matches.
* @param color The highlighting color of the matches.
* @param noDialogs Whether a search dialog shall be shown.
......
......@@ -59,7 +59,7 @@ class TextPage;
*
* This class encapsulates information about an export format.
* Every Generator can support 0 or more export formats which can be
* queried with @see Generator::exportFormats().
* queried with @ref Generator::exportFormats().
*/
class OKULAR_EXPORT ExportFormat
{
......@@ -246,12 +246,12 @@ class OKULAR_EXPORT Generator : public QObject
};
/**
* This method returns the metric of the page size. Default is @see None.
* This method returns the metric of the page size. Default is @ref None.
*/
virtual PageSizeMetric pagesSizeMetric() const;
/**
* This method returns whether given action (@see Permission) is
* This method returns whether given action (@ref Permission) is
* allowed in this document.
*/
virtual bool isAllowed( Permissions action ) const;
......@@ -335,7 +335,7 @@ class OKULAR_EXPORT Generator : public QObject
protected:
/**
* This method must be called when the pixmap request triggered by @see generatePixmap()
* This method must be called when the pixmap request triggered by generatePixmap()
* has been finished.
*/
void signalRequestDone( PixmapRequest * request );
......
......@@ -113,7 +113,7 @@ class OKULAR_EXPORT Page : public QObject
bool hasPixmap( int id, int width = -1, int height = -1 ) const;
/**
* Returns whether the page provides a text page (@see TextPage).
* Returns whether the page provides a text page (@ref TextPage).
*/
bool hasTextPage() const;
......@@ -145,7 +145,7 @@ class OKULAR_EXPORT Page : public QObject
*
* @param id An unique id for this search.
* @param text The search text.
* @param direction The direction of the search (@see SearchDirection)
* @param direction The direction of the search (@ref SearchDirection)
* @param caseSensitivity If Qt::CaseSensitive, the search is case sensitive; otherwise
* the search is case insensitive.
* @param lastRect If 0 (default) the search starts at the beginning of the page, otherwise
......@@ -171,7 +171,8 @@ class OKULAR_EXPORT Page : public QObject
const ObjectRect * objectRect( ObjectRect::ObjectType type, double x, double y, double xScale, double yScale ) const;
/**
* Returns the transition effect of the page or 0 if no transition effect is set (@see hasTransition).
* Returns the transition effect of the page or 0 if no transition
* effect is set (see hasTransition()).
*/
const PageTransition * transition() const;
......@@ -181,7 +182,7 @@ class OKULAR_EXPORT Page : public QObject
const QLinkedList< Annotation* > annotations() const;
/**
* Returns the @see Link object which is associated with the given page @p action
* Returns the @ref Link object which is associated with the given page @p action
* or 0 if no page action is set.
*/
const Link * pageAction( PageAction action ) const;
......
......@@ -43,7 +43,7 @@ class OKULAR_EXPORT PageTransition
};
/**
* Describes the alignment that is applied to the @see Type
* Describes the alignment that is applied to the @ref Type
* of transition effect.
*/
enum Alignment {
......@@ -52,7 +52,7 @@ class OKULAR_EXPORT PageTransition
};
/**
* Describes the direction that is applied to the @see Type
* Describes the direction that is applied to the @ref Type
* of transition effect.
*/
enum Direction {
......@@ -63,7 +63,7 @@ class OKULAR_EXPORT PageTransition
/**
* Creates a new page transition of the given @p type.
*
* If no type is given, the normal @see Replace transition is used.
* If no type is given, the normal @ref Replace transition is used.
*/
PageTransition( Type type = Replace );
......@@ -114,7 +114,7 @@ class OKULAR_EXPORT PageTransition
bool isRectangular() const;
/**
* Sets the @p type of the transition (@see Type).
* Sets the @p type of the transition (@ref Type).
*/
void setType( Type type );
......@@ -124,7 +124,7 @@ class OKULAR_EXPORT PageTransition
void setDuration( int duration );
/**
* Sets the @p alignment of the transition (@see Alignment).
* Sets the @p alignment of the transition (@ref Alignment).
*/
void setAlignment( Alignment alignment );
......
......@@ -103,7 +103,7 @@ class OKULAR_EXPORT TextPage
/**
* Appends the given @p text with the given @p area as new
* @see TextItem to the page.
* @ref TextEntity to the page.
*/
void append( const QString &text, NormalizedRect *area );
......@@ -113,7 +113,7 @@ class OKULAR_EXPORT TextPage
*
* @param id An unique id for this search.
* @param text The search text.
* @param direction The direction of the search (@see SearchDirection)
* @param direction The direction of the search (@ref SearchDirection)
* @param caseSensitivity If Qt::CaseSensitive, the search is case sensitive; otherwise
* the search is case insensitive.
* @param lastRect If 0 the search starts at the beginning of the page, otherwise
......@@ -123,6 +123,8 @@ class OKULAR_EXPORT TextPage
Qt::CaseSensitivity caseSensitivity, const RegularAreaRect *lastRect );
/**
* Text extraction function.
*
* Returns:
* - a null string if @p rect is a valid pointer to a null area
* - the whole page text if @p rect is a null pointer
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment