D7369: Wayland foreign protocol

[Martin Flöser]

graesslin added a comment.


  There is still quite some documentation missing. Especially the server side is not yet documented enough that I would know how to use the new API and what it does. It's totally fine to copy and adapt the documentation from the Wayland xml protocol.

INLINE COMMENTS

> xdgforeign.h:116
> +
> +    XdgExported *exportSurface(Surface *surface, QObject *parent = nullptr);
> +

Please add documentation

> xdgforeign.h:208
> +
> +    XdgImported *import(const QString & handle, QObject *parent = nullptr);
> +

Please add documentation

> xdgforeign.h:268
> +
> +    QString handle() const;
> +

what's the handle?

> xdgforeign.h:327
> +
> +    void setParentOf(Surface *surface);
> +

please add documentation

> xdgforeign_interface.h:38
> +
> +class KWAYLANDSERVER_EXPORT XdgForeignInterface : public QObject
> +{

This needs documentation

> xdgforeign_interface.h:45-46
> +
> +    void create();
> +    bool isValid();
> +

Please add documentation? I wouldn't know what create is needed for.

> xdgforeign_interface.h:49
> +    /**
> +     * if a client did set 
> +     */

did set "what"?

REPOSITORY
  R127 KWayland

REVISION DETAIL
  https://phabricator.kde.org/D7369

To: mart, #plasma, #kwin, davidedmundson, graesslin
Cc: davidedmundson, graesslin, plasma-devel, #frameworks, leezu, ZrenBot, alexeymin, progwolff, lesliezhai, ali-mohamed, jensreuterberg, abetts, eliasp, sebas, apol, mart, hein
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20171011/f10b2649/attachment.html>