Merge lp:~robertcarr/mir/five-minutes-of-doxygen into lp:~mir-team/mir/trunk

[Robert Carr]

Five minutes of doxygen comments.

Five minutes of doxygen comments :)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:551
http://jenkins.qa.ubuntu.com/job/mir-ci/269/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/218
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/101
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/270
        deb: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/270/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=precise,flavor=amd64/78

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/269/rebuild

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

On 01/04/13 21:46, Robert Carr wrote:
> +// TODO: As this is due to be implemented in the graphics namespace for rendering the cursor perhaps this interface
> +// belongs in mir::graphics

It doesn't matter where an interface is to be implemented (there could
be several implementations in different places), it is where it is used
that should determine where the interface belongs.

--
Alan Griffiths [phone]
Octopull Ltd http://www.octopull.co.uk/

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:552
http://jenkins.qa.ubuntu.com/job/mir-ci/272/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-raring-i386-build/221
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-raring-amd64-build/104
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/273
        deb: http://jenkins.qa.ubuntu.com/job/mir-quantal-amd64-ci/273/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-vm-ci-build/./distribution=precise,flavor=amd64/81

Click here to trigger a rebuild:
http://s-jenkins:8080/job/mir-ci/272/rebuild

review: Approve (continuous-integration)

[Kevin DuBois (kdub)]

seems ok

review: Approve

=== modified file 'include/server/mir/input/cursor_listener.h'
--- include/server/mir/input/cursor_listener.h	2013-03-13 04:54:15 +0000
+++ include/server/mir/input/cursor_listener.h	2013-04-01 22:18:30 +0000
@@ -24,6 +24,8 @@
 namespace input
 {
 
+/// An interface for listening to absolute cursor events (without context): For example to update
+/// the position of the visible cursor.
 class CursorListener
 {
 public:
 
=== modified file 'include/server/mir/input/input_channel.h'
--- include/server/mir/input/input_channel.h	2013-03-29 16:51:35 +0000
+++ include/server/mir/input/input_channel.h	2013-04-01 22:18:30 +0000
@@ -24,6 +24,7 @@
 namespace input
 {
 
+/// Encapsulates a paired set of fd's suitable for input communication.
 class InputChannel
 {
 public:
 
=== modified file 'src/server/input/android/android_input_manager.h'
--- src/server/input/android/android_input_manager.h	2013-03-29 16:51:35 +0000
+++ src/server/input/android/android_input_manager.h	2013-04-01 22:18:30 +0000
@@ -52,6 +52,9 @@
 class InputThread;
 class InputConfiguration;
 
+/// Encapsulates an instance of the Android input stack, that is to say an EventHub tied
+/// to an InputReader tied to an InputDispatcher. Provides interfaces for controlling input
+/// policy and dispatch (through public API and policy objects in InputConfiguration).
 class InputManager : public mir::input::InputManager
 {
 public: