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 /rfb/rfbproto.h | |
| parent | a5f8d3a3109b545219ad5b34859f1b7d3b8b6d56 (diff) | |
| download | libtdevnc-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 'rfb/rfbproto.h')
| -rw-r--r-- | rfb/rfbproto.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/rfb/rfbproto.h b/rfb/rfbproto.h index 6fe14bc..023528b 100644 --- a/rfb/rfbproto.h +++ b/rfb/rfbproto.h @@ -1,6 +1,17 @@ #ifndef RFBPROTO_H #define RFBPROTO_H +/** + @mainpage + @li @ref libvncserver_api + @li @ref libvncserver_doc + + + @li @ref libvncclient_api + @li @ref libvncclient_doc + +*/ + /* * Copyright (C) 2005 Rohit Kumar, Johannes E. Schindelin * Copyright (C) 2000-2002 Constantin Kaplinsky. All Rights Reserved. |