diff options
author | Christian Beier <dontmind@freeshell.org> | 2010-11-18 13:14:20 +0100 |
---|---|---|
committer | Christian Beier <dontmind@freeshell.org> | 2010-11-18 15:00:51 +0100 |
commit | 705a5d46e66d18fe3a50072b12e5245a01fd2ed2 (patch) | |
tree | 465b7bbf3cfa15d7eb1e0ed0cf42d40d8e69b667 /client_examples/backchannel.c | |
parent | a5f8d3a3109b545219ad5b34859f1b7d3b8b6d56 (diff) | |
download | libvncserver-705a5d46e66d18fe3a50072b12e5245a01fd2ed2.zip libvncserver-705a5d46e66d18fe3a50072b12e5245a01fd2ed2.tar.gz |
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 'client_examples/backchannel.c')
-rw-r--r-- | client_examples/backchannel.c | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/client_examples/backchannel.c b/client_examples/backchannel.c index 643754e..04d154e 100644 --- a/client_examples/backchannel.c +++ b/client_examples/backchannel.c @@ -1,4 +1,7 @@ -/* A simple example of an RFB client */ +/** + * @example backchannel-client.c + * A simple example of an RFB client + */ #include <stdio.h> #include <stdlib.h> |