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

[Dennis Nienhüser]

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



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

    I wouldn't write 'difference' because it sounds exclusive. We have other plugins with similar behavior (e.g. webpopup) which do not inherit AbstractFloatItem.
    
    So I'd shorten it to 'It keeps floating on top of the map at a given screen position'



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

    Where will it be used?



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

    Where will it be used?
    



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

    This is a virtual method which is already documented in LayerInterface. Either it shouldn't be documented here (so that doxygen copies the original documentation) or it should reference that documentation.



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

    This is a virtual method which is already documented in LayerInterface. Either it shouldn't be documented here (so that doxygen copies the original documentation) or it should reference that documentation.



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

    This is a virtual method which is already documented in LayerInterface. Either it shouldn't be documented here (so that doxygen copies the original documentation) or it should reference that documentation.



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

    Please add:
    
    @note: Typically this method is implemented with the help of the MARBLE_PLUGIN() macro.



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

    can check/uncheck plugin's menu action
    => can control plugin visibility



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

    This method is called to determine the current settings of the plugin for serialization, e.g. when closing the application.



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

    Usually this is called at startup to restore saved settings.



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

    Please move to / merge with the original method in LayerInterface.h



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

    What are the consequences?



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

    check the action => control visibility



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

    Passes an empty set of settings to the plugin. Well behaving plugins restore their settings to default values as a result of calling this method.
    



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

    Sounds driven from the user interface, I'd remove it.



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

    The action is checkable and controls the visibility of the plugin.


- Dennis Nienhüser


On Dec. 27, 2012, 12:56 p.m., Illya Kovalevskyy wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/107914/
> -----------------------------------------------------------
> 
> (Updated Dec. 27, 2012, 12:56 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/20121228/5739073d/attachment-0001.html>