[Marble-devel] Review Request: Create API docs for PopupItem and MapInfoItem

[Dennis Nienhüser]

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



src/lib/MapInfoDialog.h
<http://git.reviewboard.kde.org/r/108173/#comment18958>

    This one should be the more detailed (compared to PopupItem) since that is the API people will use.
    
    "A popup dialog opening on top of the map. The content is shown in a QWebView, acting like a minimalistic web browser. The dialog is either shown aligned to a geo position or shown at a specific screen position:"



src/lib/MapInfoDialog.h
<http://git.reviewboard.kde.org/r/108173/#comment18959>

    "Use a geo position as the dialog base position. The dialog will be shown if it is visible and if the map viewport includes the given coordinates. This invalidates a screen position set with setPosition(), if any."



src/lib/MapInfoDialog.h
<http://git.reviewboard.kde.org/r/108173/#comment18960>

    Alignment of the dialog from the point of view of the coordinates. For example, Qt::AlignRight | Qt::AlignVCenter shows the dialog to the right of the geo position, vertically centered. An arrow points from the dialog to the geo position.



src/lib/MapInfoDialog.h
<http://git.reviewboard.kde.org/r/108173/#comment18961>

    Sets the size of the dialog (including the arrow, if any).



src/lib/MapInfoDialog.h
<http://git.reviewboard.kde.org/r/108173/#comment18962>

    Sets the position of the dialog to the given screen position. Any geo position set with setCoordinates() is invalidated.
    
    (the warning should stay)



src/lib/MapInfoDialog.h
<http://git.reviewboard.kde.org/r/108173/#comment18963>

    Should be a private slot and not documented. setVisible( false ) is what people shall call.



src/lib/PopupItem.h
<http://git.reviewboard.kde.org/r/108173/#comment18964>

    PopupItem cannot be accessed via MapInfoDialog, so this method should be available there, too (calling this method).



src/lib/PopupItem.h
<http://git.reviewboard.kde.org/r/108173/#comment18965>

    Should be private



src/lib/PopupItem.h
<http://git.reviewboard.kde.org/r/108173/#comment18966>

    Should be private
    
    setVisible( false ) clears the history automatically.


- Dennis Nienhüser


On Jan. 4, 2013, 8:37 p.m., Illya Kovalevskyy wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/108173/
> -----------------------------------------------------------
> 
> (Updated Jan. 4, 2013, 8:37 p.m.)
> 
> 
> Review request for Marble, Dennis Nienhüser and Torsten Rahn.
> 
> 
> Description
> -------
> 
> API docs for PopupItem and MapInfoItem were created according to the GCI task:
>  - https://google-melange.appspot.com/gci/task/view/google/gci2012/8149211
> 
> 
> Diffs
> -----
> 
>   src/lib/MapInfoDialog.h f819d4a 
>   src/lib/PopupItem.h 7f689ff 
> 
> Diff: http://git.reviewboard.kde.org/r/108173/diff/
> 
> 
> Testing
> -------
> 
> Everything is OK.
> 
> 
> Thanks,
> 
> Illya Kovalevskyy
> 
>

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