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>
---
 examples/pnmshow.c | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'examples/pnmshow.c')

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>
-- 
cgit v1.2.3