Changeset 422

Show
Ignore:
Timestamp:
07/29/08 14:34:09 (4 months ago)
Author:
sroret
Message:

Fix documentation.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/BAL/WKAL/Skeletons/Graphics/GraphicsContext.t

    r420 r422  
    7171    const int cTextStroke = 2; 
    7272    const int cTextClip = 4; 
    73      
     73 
    7474    enum StrokeStyle { 
    7575        NoStroke, 
    …… 
    9797     */ 
    9898        ~GraphicsContext(); 
    99         
     99 
    100100    /** 
    101101     * get platform graphic context 
    …… 
    108108 
    109109    /** 
    110      * get font  
     110     * get font 
    111111     * @param[out] : font 
    112112     * @code 
    …… 
    117117 
    118118    /** 
    119      * set font  
     119     * set font 
    120120     * @param[in] : font 
    121121     * @code 
    …… 
    124124     */ 
    125125        void setFont(const Font&); 
    126          
     126 
    127127    /** 
    128128     * get stroke thickness 
    …… 
    196196     */ 
    197197        void setFillColor(const Color&); 
    198          
     198 
    199199    /** 
    200200     * save context 
    …… 
    212212     */ 
    213213        void restore(); 
    214          
     214 
    215215        // These draw methods will do both stroking and filling. 
    216216    /** 
    …… 
    224224 
    225225    /** 
    226      * draw line  
     226     * draw line 
    227227     * @param[in] : start point 
    228228     * @param[in] : end point 
    …… 
    264264     */ 
    265265        void strokeArc(const IntRect&, int startAngle, int angleSpan); 
    266          
     266 
    267267    /** 
    268268     * fill rect 
    …… 
    308308     */ 
    309309        void fillRoundedRect(const IntRect&, const IntSize& topLeft, const IntSize& topRight, const IntSize& bottomLeft, const IntSize& bottomRight, const Color&); 
    310          
     310 
    311311    /** 
    312312     * clear rect 
    …… 
    340340 
    341341    /** 
    342      * draw image  
     342     * draw image 
    343343     * @param[in] : image 
    344344     * @param[in] : rect 
    …… 
    391391 
    392392    /** 
    393      * draw tiled image  
     393     * draw tiled image 
    394394     * @param[in] : image 
    395395     * @param[in] : destination rect 
    …… 
    416416     * @endcode 
    417417     */ 
    418         void drawTiledImage(Image*, const IntRect& destRect, const IntRect& srcRect,  
     418        void drawTiledImage(Image*, const IntRect& destRect, const IntRect& srcRect, 
    419419                            Image::TileRule hRule = Image::StretchTile, Image::TileRule vRule = Image::StretchTile, 
    420420                            CompositeOperator = CompositeSourceOver); 
    …… 
    433433 
    434434    /** 
    435      *  imageInterpolationQuality description 
    436      * @param[in] : description 
    437      * @param[out] : description 
     435     * Get the image interpolation quality. 
     436     * @return InterpolationQuality the interpolation quality 
    438437     * @code 
    439438     * @endcode 
    …… 
    444443 
    445444    /** 
    446      * clip description 
    447      * @param[in] : description 
    448      * @param[out] : description 
    449      * @code 
     445     * Clip context: no graphics outside the rect will be drawn. 
     446     * @param[in] FloatRect the rect setting the clip. 
     447     * @code 
     448     * gc->clip(r); 
    450449     * @endcode 
    451450     */ 
    …… 
    453452 
    454453    /** 
    455      *  addRoundedRectClip description 
    456      * @param[in] : description 
    457      * @param[out] : description 
    458      * @code 
    459      * @endcode 
    460      */ 
    461  
     454     * add rounded rect clip 
     455     * @param[in] : rect 
     456     * @param[in] : top left size 
     457     * @param[in] : top right size 
     458     * @param[in] : bottom left size 
     459     * @param[in] : bottom right size 
     460     * @code 
     461     * gc->addRoundedRectClip(r, tl, tr, bk, br); 
     462     * @endcode 
     463     */ 
    462464        void addRoundedRectClip(const IntRect&, const IntSize& topLeft, const IntSize& topRight, const IntSize& bottomLeft, const IntSize& bottomRight); 
    463465 
    464466    /** 
    465      * addInnerRoundedRectClip description 
    466      * @param[in] : description 
    467      * @param[out] : description 
    468      * @code 
    469      * @endcode 
    470      */ 
    471  
     467     * add inner rounded rect clip 
     468     * @param[in] : rect 
     469     * @param[in] : thickness 
     470     * @code 
     471     * gc->addInnerRoundedRectClip(r, t); 
     472     * @endcode 
     473     */ 
    472474        void addInnerRoundedRectClip(const IntRect&, int thickness); 
    473475 
    …… 
    576578     */ 
    577579        FloatRect roundToDevicePixels(const FloatRect&); 
    578          
     580 
    579581    /** 
    580582     * draw line for text 
    …… 
    598600     */ 
    599601        void drawLineForMisspellingOrBadGrammar(const IntPoint&, int width, bool grammar); 
    600          
     602 
    601603    /** 
    602604     * test if the painting is disabled 
    …… 
    609611 
    610612    /** 
    611      * set painting disabled  
     613     * set painting disabled 
    612614     * @param[in] : status 
    613615     * @code 
    …… 
    616618     */ 
    617619        void setPaintingDisabled(bool); 
    618          
     620 
    619621    /** 
    620622     * updating control tints 
    …… 
    645647 
    646648    /** 
    647      * end transparency layer  
     649     * end transparency layer 
    648650     * @code 
    649651     * gc->endTransparencyLayer(); 
    …… 
    694696 
    695697    /** 
    696      * add focus ring rect  
     698     * add focus ring rect 
    697699     * @param[in] : rect 
    698700     * @code 
    …… 
    738740 
    739741    /** 
    740      * set lineJoin  
     742     * set lineJoin 
    741743     * @param[in] : lineJoin 
    742744     * @code 
    …… 
    843845     */ 
    844846        IntPoint origin(); 
    845          
    846     /** 
    847      * set URL for rect  
     847 
     848    /** 
     849     * set URL for rect 
    848850     * @param[in] : url 
    849851     * @param[in] : rect 
    …… 
    873875 
    874876    /** 
    875      * set use antialiasing  
     877     * set use antialiasing 
    876878     * @param[in] : status 
    877879     * @code 
    …… 
    909911 
    910912    /** 
    911      * translate point  
     913     * translate point 
    912914     * @param[in] : point 
    913915     * @param[out] : point translated