mirror of
https://github.com/gyurix1968/guacamole-client.git
synced 2025-09-06 05:07:41 +00:00
Documentation - initial trial of doxygen within guac
This commit is contained in:
1551
guacamole/libguac/Doxyfile
Normal file
1551
guacamole/libguac/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
@@ -2,10 +2,16 @@
|
|||||||
CFLAGS=-O2 -fPIC -pedantic -Wall -Werror -Iinclude
|
CFLAGS=-O2 -fPIC -pedantic -Wall -Werror -Iinclude
|
||||||
LDFLAGS=-lpng
|
LDFLAGS=-lpng
|
||||||
|
|
||||||
.PHONY: clean
|
.PHONY: clean doc
|
||||||
|
|
||||||
all: libguac.so
|
all: libguac.so
|
||||||
|
|
||||||
|
doc:
|
||||||
|
doxygen
|
||||||
|
|
||||||
|
clean-doc:
|
||||||
|
$(RM) -R doc/*
|
||||||
|
|
||||||
libguac.so: client.o guacio.o protocol.o
|
libguac.so: client.o guacio.o protocol.o
|
||||||
$(CC) $(CFLAGS) -shared $(LDFLAGS) -Wl,-soname,libguac.so.0 -o libguac.so client.o protocol.o guacio.o
|
$(CC) $(CFLAGS) -shared $(LDFLAGS) -Wl,-soname,libguac.so.0 -o libguac.so client.o protocol.o guacio.o
|
||||||
|
|
||||||
|
@@ -24,9 +24,27 @@
|
|||||||
|
|
||||||
#include "guacio.h"
|
#include "guacio.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Guacamole proxy client.
|
||||||
|
*
|
||||||
|
* Represents a Guacamole proxy client (the client which communicates to
|
||||||
|
* a server on behalf of Guacamole, on behalf of the web-client).
|
||||||
|
*/
|
||||||
typedef struct guac_client {
|
typedef struct guac_client {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The GUACIO structure to be used to communicate with the web-client. It is
|
||||||
|
* expected that the implementor of any Guacamole proxy client will provide
|
||||||
|
* their own mechanism of I/O for their protocol. The GUACIO structure is
|
||||||
|
* used only to communicate conveniently with the Guacamole web-client.
|
||||||
|
*/
|
||||||
GUACIO* io;
|
GUACIO* io;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Arbitrary reference to proxy client-specific data. Implementors of a
|
||||||
|
* Guacamole proxy client can store any data they want here, which can then
|
||||||
|
* be retrieved as necessary in the message handlers.
|
||||||
|
*/
|
||||||
void* data;
|
void* data;
|
||||||
|
|
||||||
void (*handle_messages)(struct guac_client* client);
|
void (*handle_messages)(struct guac_client* client);
|
||||||
|
Reference in New Issue
Block a user