summaryrefslogtreecommitdiffstats
path: root/examples/vncev.c
diff options
context:
space:
mode:
authorChristian Beier <dontmind@freeshell.org>2010-11-18 13:14:20 +0100
committerChristian Beier <dontmind@freeshell.org>2010-11-18 15:00:51 +0100
commit705a5d46e66d18fe3a50072b12e5245a01fd2ed2 (patch)
tree465b7bbf3cfa15d7eb1e0ed0cf42d40d8e69b667 /examples/vncev.c
parenta5f8d3a3109b545219ad5b34859f1b7d3b8b6d56 (diff)
downloadlibtdevnc-705a5d46e66d18fe3a50072b12e5245a01fd2ed2.tar.gz
libtdevnc-705a5d46e66d18fe3a50072b12e5245a01fd2ed2.zip
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>
Diffstat (limited to 'examples/vncev.c')
-rw-r--r--examples/vncev.c5
1 files changed, 4 insertions, 1 deletions
diff --git a/examples/vncev.c b/examples/vncev.c
index affac00..9ebafc9 100644
--- a/examples/vncev.c
+++ b/examples/vncev.c
@@ -1,4 +1,7 @@
-/* This program is a simple server to show events coming from the client */
+/**
+ * @example vncev.c
+ * This program is a simple server to show events coming from the client
+*/
#ifdef __STRICT_ANSI__
#define _BSD_SOURCE
#endif