diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2012-06-28 11:10:06 +1000 |
|---|---|---|
| committer | Chase Douglas <chase.douglas@canonical.com> | 2012-07-20 14:28:50 -0700 |
| commit | 4e62312cb41095b3f237efa164166523d2963a0f (patch) | |
| tree | 2ece93f76a174aa5f872443703e3c509a1c7fceb | |
| parent | 18e54c378cf3773ef61bdbd07152977227090ee3 (diff) | |
xserver: update documentation
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>
Signed-off-by: Chase Douglas <chase.douglas@canonical.com>
| -rw-r--r-- | include/xorg/gtest/xorg-gtest-xserver.h | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/include/xorg/gtest/xorg-gtest-xserver.h b/include/xorg/gtest/xorg-gtest-xserver.h index 4a778c6..71857d3 100644 --- a/include/xorg/gtest/xorg-gtest-xserver.h +++ b/include/xorg/gtest/xorg-gtest-xserver.h @@ -40,7 +40,21 @@ namespace testing { /** * @class XServer xorg-gtest-xserver.h xorg/gtest/xorg-gtest-xserver.h * - * Miscellaneous interfaces to communicate with the X server. + * Class representing the X server process. + * + * @code + * XServer server; + * server.SetOption("-logfile", "/tmp/Xserver.log"); + * server.Start(); + * + * ... + * + * if (!server.Terminate()) { + * std::cerr << "Problem terminating server ... killing now ..." << std::endl; + * if (!server.Kill()) + * std::cerr << "Problem killing server" << std::endl; + * } + * @endcode */ class XServer : public xorg::testing::Process { public: |