[Marble-devel] Review Request: RenderPlugin and AbstractFloatItem have been covered with Doxygen

[Torsten Rahn]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/107914/#review24010
-----------------------------------------------------------



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18275>

    "is an item displayed on the marble widget". Hm, that also applies to all other render plugins (like the earthquake, wikipedia, postal and flickr items). 
    



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18276>

    "main render function" ? Is there a "side render function" as well? :-)



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18279>

    I guess that should refer to the GeoPainter :)



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18277>

    "position of the rendering" ? Hm, I could have guessed that from the name already. But which position? Latitude and longitude? z-Position or what?



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18278>

    What is the layer? :)



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18280>

    What are the possible values? What is the purpose :) ?



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18281>

    If it's just a single position, why does it pass a List? :) And what is the position anyways? The Latitude, Longitude, a z-Coordinate or what? :)



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18282>

    "* the item can't be moved with the cursor (in the UI)"
    
    (English is pretty cool because it doesn't distinguish between male and female articles - I promise you'd hate german with "der, die, das" ;-)



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18283>

    " * If the item ....."



src/lib/AbstractFloatItem.h
<http://git.reviewboard.kde.org/r/107914/#comment18284>

    see above



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18285>

    I would describe it in more different wording from what the class / method is named: So use draw or paint instead of "render":
    
    " * Renderable Plugins can be used to extend Marble's functionality: They allow to draw stuff on top of the map / globe.



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18286>

    I think it's more a Type of plugin.



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18287>

     * This method is used to create a new object of the current ............



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18288>

    How is "enable" different from "visible" from a user's perspective? :-)
    Where does the plugin get listed when it's enabled? How does it related to isUserCheckable?



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18289>

    How is visible different from enable from a user's perspective? How does it relate to isUserCheckable?



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18290>

    How does this relate to visible and enabled?



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18291>

    What kinds of Types are there?



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18292>

     * Each render plugin can be displayed in the menu - this ..........



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18293>

        * This signal is emitted if the enabled property is changed with @see setEnabled



src/lib/RenderPlugin.h
<http://git.reviewboard.kde.org/r/107914/#comment18294>

        * This signal is emitted if the user checkable property is changed with @see setUserCheckable


- Torsten Rahn


On Dec. 26, 2012, 9:45 p.m., Illya Kovalevskyy wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/107914/
> -----------------------------------------------------------
> 
> (Updated Dec. 26, 2012, 9:45 p.m.)
> 
> 
> Review request for Marble, Dennis Nienhüser and Torsten Rahn.
> 
> 
> Description
> -------
> 
> RenderPlugin and AbstractFloatItem have been covered with Doxygen comments according to the GCI task:
>  - https://google-melange.appspot.com/gci/task/view/google/gci2012/8087207
> 
> 
> Diffs
> -----
> 
>   src/lib/AbstractFloatItem.h e7c2c15 
>   src/lib/RenderPlugin.h 1ae5385 
> 
> Diff: http://git.reviewboard.kde.org/r/107914/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Illya Kovalevskyy
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/marble-devel/attachments/20121226/b4e224f9/attachment-0001.html>