Fix missing doc strings due to invalid doxygen tags

Author: nyalldawson

python/core/composer/qgscomposerhtml.sip

@@ -10,8 +10,8 @@ class QgsComposerHtml: QgsComposerMultiFrame
     */
     enum ContentMode
     {
-      Url, /*< Using this mode item fetches its content via a url*/
-      ManualHtml /*< HTML content is manually set for the item*/
+      Url, /*!< Using this mode item fetches its content via a url*/
+      ManualHtml /*!< HTML content is manually set for the item*/
     };
 
     QgsComposerHtml( QgsComposition* c /TransferThis/, bool createUndoCommands );

python/core/composer/qgscomposeritem.sip

@@ -143,10 +143,10 @@ class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
      */
     enum ZoomMode
     {
-      Zoom = 0, /*< Zoom to center of content */
-      ZoomRecenter, /*< Zoom and recenter content to point */
-      ZoomToPoint, /*< Zoom while maintaining relative position of point */
-      NoZoom /*< No zoom */
+      Zoom = 0, /*!< Zoom to center of content */
+      ZoomRecenter, /*!< Zoom and recenter content to point */
+      ZoomToPoint, /*!< Zoom while maintaining relative position of point */
+      NoZoom /*!< No zoom */
     };
 
     /**Constructor

python/core/composer/qgscomposermap.sip

@@ -87,13 +87,13 @@ class QgsComposerMap : QgsComposerItem
      */
     enum AtlasScalingMode
     {
-      Fixed,      /*< The current scale of the map is used for each feature of the atlas */
-      Predefined, /*< A scale is chosen from the predefined scales. The smallest scale from
+      Fixed,      /*!< The current scale of the map is used for each feature of the atlas */
+      Predefined, /*!< A scale is chosen from the predefined scales. The smallest scale from
                     the list of scales where the atlas feature is fully visible is chosen.
                     @see QgsAtlasComposition::setPredefinedScales.
                     @note This mode is only valid for polygon or line atlas coverage layers
                 */
-      Auto        /*< The extent is adjusted so that each feature is fully visible.
+      Auto        /*!< The extent is adjusted so that each feature is fully visible.
                     A margin is applied around the center @see setAtlasMargin
                     @note This mode is only valid for polygon or line atlas coverage layers*/
     };

python/core/composer/qgscomposermapgrid.sip

@@ -128,104 +128,104 @@ class QgsComposerMapGrid : QgsComposerMapItem
      */
     enum GridUnit
     {
-      MapUnit, /*< grid units follow map units */
-      MM, /*< grid units in millimetres */
-      CM /*< grid units in centimetres */
+      MapUnit, /*!< grid units follow map units */
+      MM, /*!< grid units in millimetres */
+      CM /*!< grid units in centimetres */
     };
 
     /** Grid drawing style
      */
     enum GridStyle
     {
       Solid,
-      Cross, /*< draw line crosses at intersections of grid lines */
-      Markers, /*< draw markers at intersections of grid lines */
-      FrameAnnotationsOnly /*< no grid lines over the map, only draw frame and annotations */
+      Cross, /*!< draw line crosses at intersections of grid lines */
+      Markers, /*!< draw markers at intersections of grid lines */
+      FrameAnnotationsOnly /*!< no grid lines over the map, only draw frame and annotations */
     };
 
     /** Display settings for grid annotations and frames
      */
     enum DisplayMode
     {
-      ShowAll = 0, /*< show both latitude and longitude annotations/divisions */
-      LatitudeOnly, /*< show latitude/y annotations/divisions only */
-      LongitudeOnly, /*< show longitude/x annotations/divisions only */
-      HideAll /*< no annotations */
+      ShowAll = 0, /*!< show both latitude and longitude annotations/divisions */
+      LatitudeOnly, /*!< show latitude/y annotations/divisions only */
+      LongitudeOnly, /*!< show longitude/x annotations/divisions only */
+      HideAll /*!< no annotations */
     };
 
     /** Position for grid annotations
      */
     enum AnnotationPosition
     {
       InsideMapFrame = 0,
-      OutsideMapFrame, /*< draw annotations outside the map frame */
-      Disabled /*< disable annotation
+      OutsideMapFrame, /*!< draw annotations outside the map frame */
+      Disabled /*!< disable annotation
                   * @deprecated in QGIS 2.7, use QgsComposerMapGrid::HideAll instead */
     };
 
     /** Direction of grid annotations
      */
     enum AnnotationDirection
     {
-      Horizontal = 0, /*< draw annotations horizontally */
-      Vertical, /*< draw annotations vertically, ascending */
-      VerticalDescending, /*< draw annotations vertically, descending */
-      BoundaryDirection /*< annotations follow the boundary direction */
+      Horizontal = 0, /*!< draw annotations horizontally */
+      Vertical, /*!< draw annotations vertically, ascending */
+      VerticalDescending, /*!< draw annotations vertically, descending */
+      BoundaryDirection /*!< annotations follow the boundary direction */
     };
 
     /** Format for displaying grid annotations
      */
     enum AnnotationFormat
     {
-      Decimal, /*< decimal degrees, use - for S/W coordinates */
-      DegreeMinute, /*< degree/minutes, use NSEW suffix */
-      DegreeMinuteSecond, /*< degree/minutes/seconds, use NSEW suffix */
-      DecimalWithSuffix, /*< decimal degrees, use NSEW suffix */
-      DegreeMinuteNoSuffix, /*< degree/minutes, use - for S/W coordinates */
-      DegreeMinutePadded, /*< degree/minutes, with minutes using leading zeros were required */
-      DegreeMinuteSecondNoSuffix, /*< degree/minutes/seconds, use - for S/W coordinates */
-      DegreeMinuteSecondPadded /*< degree/minutes/seconds, with minutes using leading zeros were required */
+      Decimal, /*!< decimal degrees, use - for S/W coordinates */
+      DegreeMinute, /*!< degree/minutes, use NSEW suffix */
+      DegreeMinuteSecond, /*!< degree/minutes/seconds, use NSEW suffix */
+      DecimalWithSuffix, /*!< decimal degrees, use NSEW suffix */
+      DegreeMinuteNoSuffix, /*!< degree/minutes, use - for S/W coordinates */
+      DegreeMinutePadded, /*!< degree/minutes, with minutes using leading zeros were required */
+      DegreeMinuteSecondNoSuffix, /*!< degree/minutes/seconds, use - for S/W coordinates */
+      DegreeMinuteSecondPadded /*!< degree/minutes/seconds, with minutes using leading zeros were required */
     };
 
     /** Border sides for annotations
      */
     enum BorderSide
     {
       Left,
-      Right, /*< right border */
-      Bottom, /*< bottom border */
-      Top /*< top border */
+      Right, /*!< right border */
+      Bottom, /*!< bottom border */
+      Top /*!< top border */
     };
 
     /** Style for grid frame
      */
     enum FrameStyle
     {
-      NoFrame, /*< disable grid frame */
-      Zebra, /*< black/white pattern */
-      InteriorTicks,  /*< tick markers drawn inside map frame */
-      ExteriorTicks,  /*< tick markers drawn outside map frame */
-      InteriorExteriorTicks, /*< tick markers drawn both inside and outside the map frame */
-      LineBorder /*< simple solid line frame */
+      NoFrame, /*!< disable grid frame */
+      Zebra, /*!< black/white pattern */
+      InteriorTicks,  /*!< tick markers drawn inside map frame */
+      ExteriorTicks,  /*!< tick markers drawn outside map frame */
+      InteriorExteriorTicks, /*!< tick markers drawn both inside and outside the map frame */
+      LineBorder /*!< simple solid line frame */
     };
 
     /** Flags for controlling which side of the map a frame is drawn on
      */
     enum FrameSideFlag
     {
-      FrameLeft, /*< left side of map */
-      FrameRight, /*< right side of map */
-      FrameTop, /*< top side of map */
-      FrameBottom /*< bottom side of map */
+      FrameLeft, /*!< left side of map */
+      FrameRight, /*!< right side of map */
+      FrameTop, /*!< top side of map */
+      FrameBottom /*!< bottom side of map */
     };
     typedef QFlags<QgsComposerMapGrid::FrameSideFlag> FrameSideFlags;
 
     /** Annotation coordinate type
      */
     enum AnnotationCoordinate
     {
-      Longitude, /*< coordinate is a longitude value */
-      Latitude /*< coordinate is a latitude value */
+      Longitude, /*!< coordinate is a longitude value */
+      Latitude /*!< coordinate is a latitude value */
     };
 
     /**Constructor for QgsComposerMapGrid.

python/core/composer/qgscomposerobject.sip

@@ -13,37 +13,37 @@ class QgsComposerObject : QObject
      */
     enum DataDefinedProperty
     {
-      NoProperty = 0, /*< no property */
-      AllProperties, /*< all properties for item */
-      TestProperty, /*< dummy property with no effect on item*/
+      NoProperty = 0, /*!< no property */
+      AllProperties, /*!< all properties for item */
+      TestProperty, /*!< dummy property with no effect on item*/
       //composer page properties
-      PresetPaperSize, /*< preset paper size for composition */
-      PaperWidth, /*< paper width */
-      PaperHeight, /*< paper height */
-      NumPages, /*< number of pages in composition */
-      PaperOrientation, /*< paper orientation */
+      PresetPaperSize, /*!< preset paper size for composition */
+      PaperWidth, /*!< paper width */
+      PaperHeight, /*!< paper height */
+      NumPages, /*!< number of pages in composition */
+      PaperOrientation, /*!< paper orientation */
       //general composer item properties
-      PageNumber, /*< page number for item placement */
-      PositionX, /*< x position on page */
-      PositionY, /*< y position on page */
-      ItemWidth, /*< width of item */
-      ItemHeight, /*< height of item */
-      ItemRotation, /*< rotation of item */
-      Transparency, /*< item transparency */
-      BlendMode, /*< item blend mode */
-      ExcludeFromExports, /*< exclude item from exports */
+      PageNumber, /*!< page number for item placement */
+      PositionX, /*!< x position on page */
+      PositionY, /*!< y position on page */
+      ItemWidth, /*!< width of item */
+      ItemHeight, /*!< height of item */
+      ItemRotation, /*!< rotation of item */
+      Transparency, /*!< item transparency */
+      BlendMode, /*!< item blend mode */
+      ExcludeFromExports, /*!< exclude item from exports */
       //composer map
-      MapRotation, /*< map rotation */
-      MapScale, /*< map scale */
-      MapXMin, /*< map extent x minimum */
-      MapYMin, /*< map extent y minimum */
-      MapXMax, /*< map extent x maximum */
-      MapYMax, /*< map extent y maximum */
-      MapAtlasMargin, /*< map atlas margin*/
+      MapRotation, /*!< map rotation */
+      MapScale, /*!< map scale */
+      MapXMin, /*!< map extent x minimum */
+      MapYMin, /*!< map extent y minimum */
+      MapXMax, /*!< map extent x maximum */
+      MapYMax, /*!< map extent y maximum */
+      MapAtlasMargin, /*!< map atlas margin*/
       //composer picture
-      PictureSource, /*< picture source url */
+      PictureSource, /*!< picture source url */
       //html item
-      SourceUrl /*< html source url */
+      SourceUrl /*!< html source url */
     };
 
     /** Specifies whether the value returned by a function should be the original, user
@@ -52,8 +52,8 @@ class QgsComposerObject : QObject
      */
     enum PropertyValueType
     {
-      EvaluatedValue = 0, /*< return the current evaluated value for the property */
-      OriginalValue /*< return the original, user set value */
+      EvaluatedValue = 0, /*!< return the current evaluated value for the property */
+      OriginalValue /*!< return the original, user set value */
     };
 
     /**Constructor

python/core/effects/qgsblureffect.sip

@@ -17,8 +17,8 @@ class QgsBlurEffect : QgsPaintEffect
     /** Available blur methods (algorithms) */
     enum BlurMethod
     {
-      StackBlur, /*< stack blur, a fast but low quality blur. Valid blur level values are between 0 - 16.*/
-      GaussianBlur /*< Gaussian blur, a slower but high quality blur. Blur level values are the distance in pixels for the blur operation. */
+      StackBlur, /*!< stack blur, a fast but low quality blur. Valid blur level values are between 0 - 16.*/
+      GaussianBlur /*!< Gaussian blur, a slower but high quality blur. Blur level values are the distance in pixels for the blur operation. */
     };
 
     /** Creates a new QgsBlurEffect effect from a properties string map.

python/core/effects/qgsgloweffect.sip

@@ -17,8 +17,8 @@ class QgsGlowEffect : QgsPaintEffect
     /** Color sources for the glow */
     enum GlowColorType
     {
-      SingleColor, /*< use a single color and fade the color to totally transparent */
-      ColorRamp /*< use colors from a color ramp */
+      SingleColor, /*!< use a single color and fade the color to totally transparent */
+      ColorRamp /*!< use colors from a color ramp */
     };
 
     QgsGlowEffect();

python/core/effects/qgsimageoperation.sip

@@ -24,17 +24,17 @@ class QgsImageOperation
     */
     enum GrayscaleMode
     {
-      GrayscaleLightness, /*< keep the lightness of the color, drops the saturation */
-      GrayscaleLuminosity, /*< grayscale by perceptual luminosity (weighted sum of color RGB components) */
-      GrayscaleAverage /*< grayscale by taking average of color RGB components */
+      GrayscaleLightness, /*!< keep the lightness of the color, drops the saturation */
+      GrayscaleLuminosity, /*!< grayscale by perceptual luminosity (weighted sum of color RGB components) */
+      GrayscaleAverage /*!< grayscale by taking average of color RGB components */
     };
 
     /** Flip operation types
     */
     enum FlipType
     {
-      FlipHorizontal, /*< flip the image horizontally */
-      FlipVertical /*< flip the image vertically */
+      FlipHorizontal, /*!< flip the image horizontally */
+      FlipVertical /*!< flip the image vertically */
     };
 
     /**Convert a QImage to a grayscale image. Alpha channel is preserved.

python/core/effects/qgspainteffect.sip

@@ -74,9 +74,9 @@ class QgsPaintEffect
     */
     enum DrawMode
     {
-      Modifier, /*< the result of the effect is not rendered, but is passed on to following effects in the stack */
-      Render, /*< the result of the effect is rendered on the destination, but does not affect subsequent effects in the stack */
-      ModifyAndRender /*< the result of the effect is both rendered and passed on to subsequent effects in the stack */
+      Modifier, /*!< the result of the effect is not rendered, but is passed on to following effects in the stack */
+      Render, /*!< the result of the effect is rendered on the destination, but does not affect subsequent effects in the stack */
+      ModifyAndRender /*!< the result of the effect is both rendered and passed on to subsequent effects in the stack */
     };
 
     QgsPaintEffect();

python/core/qgscolorscheme.sip

@@ -22,9 +22,9 @@ class QgsColorScheme
      */
     enum SchemeFlag
     {
-      ShowInColorDialog, /*< show scheme in color picker dialog */
-      ShowInColorButtonMenu, /*< show scheme in color button drop down menu */
-      ShowInAllContexts /*< show scheme in all contexts */
+      ShowInColorDialog, /*!< show scheme in color picker dialog */
+      ShowInColorButtonMenu, /*!< show scheme in color button drop down menu */
+      ShowInAllContexts /*!< show scheme in all contexts */
     };
     typedef QFlags<QgsColorScheme::SchemeFlag> SchemeFlags;