[PATCH xorg-gtest v2 8/8] xserver: update documentation

[Chase Douglas]

On 07/10/2012 08:28 PM, Peter Hutterer wrote:
> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> ---
> Changes to v1:
> - remove try/catch
>
>   include/xorg/gtest/xorg-gtest-xserver.h |   16 +++++++++++++++-
>   1 file changed, 15 insertions(+), 1 deletion(-)
>
> diff --git a/include/xorg/gtest/xorg-gtest-xserver.h b/include/xorg/gtest/xorg-gtest-xserver.h
> index 5eb402e..dc94f30 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:
>

Looks good to me :).

Reviewed-by: Chase Douglas <chase.douglas at canonical.com>