Review Request 129389: KRecentFilesAction: improve addUrl() apidox

[Elvis Angelaccio]

> On Nov. 14, 2016, 11:22 p.m., Aleix Pol Gonzalez wrote:
> > src/krecentfilesaction.h, line 146
> > <https://git.reviewboard.kde.org/r/129389/diff/1/?file=485239#file485239line146>
> >
> >     How about this?
> >     ```
> >         /**
> >          *  Adds a URL to the recent files list.
> >          *
> >          *  @param url The URL of the file
> >          *  @param name The user visible pretty name that appears before the URL
> >          *  
> >          *  @note this will create a new QAction instance.
> >          */
> >     ```

We could do this, but my point is that

    recentFiles->setEnabled(false);
    recentFiles->addUrl(QUrl(...));
    
makes `recentFiles` enabled and this could be unexpected. That's why I think we should (also) mention this in the apidox.


- Elvis


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/129389/#review100846
-----------------------------------------------------------


On Nov. 13, 2016, 11:33 a.m., Elvis Angelaccio wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/129389/
> -----------------------------------------------------------
> 
> (Updated Nov. 13, 2016, 11:33 a.m.)
> 
> 
> Review request for KDE Frameworks.
> 
> 
> Repository: kconfigwidgets
> 
> 
> Description
> -------
> 
> If we add an url to the recent files list, the recentFilesAction will be enabled. This makes sense but can be unexpected (e.g. if one manually disabled the action), so add it to the apidox of the method.
> 
> 
> Diffs
> -----
> 
>   src/krecentfilesaction.h c13c81f8e3c334e3efe229c8befcc50be37a75a0 
> 
> Diff: https://git.reviewboard.kde.org/r/129389/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Elvis Angelaccio
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20161116/8f5389dc/attachment.html>