From 705a5d46e66d18fe3a50072b12e5245a01fd2ed2 Mon Sep 17 00:00:00 2001
From: Christian Beier <dontmind@freeshell.org>
Date: Thu, 18 Nov 2010 13:14:20 +0100
Subject: Add doxygen documentation support.

    Adds automagically generating libvncserver/libvncclient API
    documentation using doxygen. This gives a nice overview on both APIs,
    include dependencies and function call/caller dependencies.

    TODO: Modify all the explaining comments in the .c files for use with
          doxygen as well.

    This patch only changes comments, no functional changes at all!

Signed-off-by: Christian Beier <dontmind@freeshell.org>
---
 client_examples/SDLvncviewer.c | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'client_examples/SDLvncviewer.c')

diff --git a/client_examples/SDLvncviewer.c b/client_examples/SDLvncviewer.c
index 5d23ec7..12ef1b0 100644
--- a/client_examples/SDLvncviewer.c
+++ b/client_examples/SDLvncviewer.c
@@ -1,3 +1,7 @@
+/**
+ * @example SDLvncviewer.c
+ */
+
 #include <SDL.h>
 #include <signal.h>
 #include <rfb/rfbclient.h>
-- 
cgit v1.2.3