From 705a5d46e66d18fe3a50072b12e5245a01fd2ed2 Mon Sep 17 00:00:00 2001 From: Christian Beier 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 --- client_examples/SDLvncviewer.c | 4 ++++ client_examples/backchannel.c | 5 ++++- client_examples/ppmtest.c | 5 ++++- client_examples/vnc2mpg.c | 3 ++- 4 files changed, 14 insertions(+), 3 deletions(-) (limited to 'client_examples') 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 #include #include 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 #include diff --git a/client_examples/ppmtest.c b/client_examples/ppmtest.c index 0422937..b8602f0 100644 --- a/client_examples/ppmtest.c +++ b/client_examples/ppmtest.c @@ -1,4 +1,7 @@ -/* A simple example of an RFB client */ +/** + * @example ppmtest.c + * A simple example of an RFB client + */ #include #include diff --git a/client_examples/vnc2mpg.c b/client_examples/vnc2mpg.c index 57fe1a8..10c3d3e 100644 --- a/client_examples/vnc2mpg.c +++ b/client_examples/vnc2mpg.c @@ -1,4 +1,5 @@ -/* +/** + * @example vnc2mpg.c * Simple movie writer for vnc; based on Libavformat API example from FFMPEG * * Copyright (c) 2003 Fabrice Bellard, 2004 Johannes E. Schindelin -- cgit v1.2.3