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 /examples | |
| 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 'examples')
| -rw-r--r-- | examples/backchannel.c | 3 | ||||
| -rw-r--r-- | examples/camera.c | 3 | ||||
| -rw-r--r-- | examples/example.c | 4 | ||||
| -rw-r--r-- | examples/filetransfer.c | 4 | ||||
| -rw-r--r-- | examples/pnmshow.c | 3 | ||||
| -rw-r--r-- | examples/pnmshow24.c | 4 | ||||
| -rw-r--r-- | examples/vncev.c | 5 |
7 files changed, 21 insertions, 5 deletions
diff --git a/examples/backchannel.c b/examples/backchannel.c index 6a21390..7aa0fa1 100644 --- a/examples/backchannel.c +++ b/examples/backchannel.c @@ -1,6 +1,7 @@ #include <rfb/rfb.h> -/* +/** + * @example backchannel.c * This is a simple example demonstrating a protocol extension. * * The "back channel" permits sending commands between client and server. diff --git a/examples/camera.c b/examples/camera.c index 23cb91a..7077790 100644 --- a/examples/camera.c +++ b/examples/camera.c @@ -1,5 +1,6 @@ -/* +/** + * @example camera.c * Question: I need to display a live camera image via VNC. Until now I just * grab an image, set the rect to modified and do a 0.1 s sleep to give the * system time to transfer the data. diff --git a/examples/example.c b/examples/example.c index 871ab0c..31bc38d 100644 --- a/examples/example.c +++ b/examples/example.c @@ -1,5 +1,5 @@ -/* - * +/** + * @example example.c * This is an example of how to use libvncserver. * * libvncserver example diff --git a/examples/filetransfer.c b/examples/filetransfer.c index dacf73d..ff4af11 100644 --- a/examples/filetransfer.c +++ b/examples/filetransfer.c @@ -1,3 +1,7 @@ +/** + * @example filetransfer.c + */ + #include <rfb/rfb.h> int main(int argc,char** argv) diff --git a/examples/pnmshow.c b/examples/pnmshow.c index 6268577..734155f 100644 --- a/examples/pnmshow.c +++ b/examples/pnmshow.c @@ -1,3 +1,6 @@ +/** +* @example pnmshow.c +*/ #include <stdio.h> #include <rfb/rfb.h> #include <rfb/keysym.h> diff --git a/examples/pnmshow24.c b/examples/pnmshow24.c index 2dec1c1..a8d6c1d 100644 --- a/examples/pnmshow24.c +++ b/examples/pnmshow24.c @@ -1,3 +1,7 @@ +/** + * @example pnmshow24.c + */ + #include <stdio.h> #include <rfb/rfb.h> #include <rfb/keysym.h> 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 |
