Merge lp:~alan-griffiths/miral/improve-doxygen into lp:miral

[Alan Griffiths]

Add a couple of missing doxygen comments

[Mir CI Bot (mir-ci-bot)]

PASSED: Continuous integration, rev:578
https://mir-jenkins.ubuntu.com/job/miral-ci/72/
Executed test runs:
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-miral/115
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-0-fetch/5130
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=artful/5119
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=xenial/5119
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-1-sourcepkg/release=zesty/5119
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=artful/119
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=artful/119/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=xenial/119
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=xenial/119/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=zesty/119
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=amd64,release=zesty/119/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=artful/119
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=artful/119/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=xenial/119
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=xenial/119/artifact/output/*zip*/output.zip
    SUCCESS: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=zesty/119
        deb: https://mir-jenkins.ubuntu.com/job/build-2-binpkg-miral/arch=i386,release=zesty/119/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://mir-jenkins.ubuntu.com/job/miral-ci/72/rebuild

review: Approve (continuous-integration)

[Gerry Boland (gerboland)]

review: Approve

=== modified file 'include/miral/command_line_option.h'
--- include/miral/command_line_option.h	2017-08-16 11:13:06 +0000
+++ include/miral/command_line_option.h	2017-08-25 09:54:58 +0000
@@ -103,6 +103,11 @@
     std::shared_ptr<Self> self;
 };
 
+/**
+ *  Update the option to be called back *before* Mir initialization starts
+ *
+ *  \param clo  the option
+ */
 auto pre_init(CommandLineOption const& clo) -> CommandLineOption;
 }
 

=== modified file 'include/miral/window_management_policy_addendum3.h'
--- include/miral/window_management_policy_addendum3.h	2017-08-10 16:59:22 +0000
+++ include/miral/window_management_policy_addendum3.h	2017-08-25 09:54:58 +0000
@@ -46,6 +46,7 @@
      * vertically maximized windows to allow adjustment for decorations.
      *
      * @param window_info   the window
+     * @param new_state     the new state
      * @param new_placement the suggested placement
      *
      * @return the confirmed placement of the window