GUACAMOLE-1538: Autogenerate docs for new library.
This commit is contained in:
parent
ce2ffdf75f
commit
1c97cdb115
@ -56,5 +56,5 @@ tests/test_*
|
||||
!tests/test_*.[ch]
|
||||
|
||||
# Generated docs
|
||||
doc/doxygen-output
|
||||
doc/*/doxygen-output
|
||||
|
||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -44,7 +44,7 @@ configure
|
||||
stamp-h1
|
||||
|
||||
# Generated docs
|
||||
doc/doxygen-output
|
||||
doc/*/doxygen-output
|
||||
|
||||
# IDE metadata
|
||||
nbproject/
|
||||
|
19
Makefile.am
19
Makefile.am
@ -89,14 +89,15 @@ if ENABLE_GUACLOG
|
||||
SUBDIRS += src/guaclog
|
||||
endif
|
||||
|
||||
EXTRA_DIST = \
|
||||
.dockerignore \
|
||||
CONTRIBUTING \
|
||||
Dockerfile \
|
||||
LICENSE \
|
||||
NOTICE \
|
||||
bin/guacctl \
|
||||
doc/Doxyfile.in \
|
||||
src/guacd-docker \
|
||||
EXTRA_DIST = \
|
||||
.dockerignore \
|
||||
CONTRIBUTING \
|
||||
Dockerfile \
|
||||
LICENSE \
|
||||
NOTICE \
|
||||
bin/guacctl \
|
||||
doc/libguac/Doxyfile.in \
|
||||
doc/libguac-terminal/Doxyfile.in \
|
||||
src/guacd-docker \
|
||||
util/generate-test-runner.pl
|
||||
|
||||
|
@ -1167,7 +1167,8 @@ AM_CONDITIONAL([ENABLE_GUACLOG], [test "x${enable_guaclog}" = "xyes"])
|
||||
#
|
||||
|
||||
AC_CONFIG_FILES([Makefile
|
||||
doc/Doxyfile
|
||||
doc/libguac/Doxyfile
|
||||
doc/libguac-terminal/Doxyfile
|
||||
src/common/Makefile
|
||||
src/common/tests/Makefile
|
||||
src/common-ssh/Makefile
|
||||
|
59
doc/libguac-terminal/Doxyfile.in
Normal file
59
doc/libguac-terminal/Doxyfile.in
Normal file
@ -0,0 +1,59 @@
|
||||
#
|
||||
# Licensed to the Apache Software Foundation (ASF) under one
|
||||
# or more contributor license agreements. See the NOTICE file
|
||||
# distributed with this work for additional information
|
||||
# regarding copyright ownership. The ASF licenses this file
|
||||
# to you under the Apache License, Version 2.0 (the
|
||||
# "License"); you may not use this file except in compliance
|
||||
# with the License. You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing,
|
||||
# software distributed under the License is distributed on an
|
||||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
# KIND, either express or implied. See the License for the
|
||||
# specific language governing permissions and limitations
|
||||
# under the License.
|
||||
#
|
||||
|
||||
#
|
||||
# Project name / version
|
||||
#
|
||||
|
||||
PROJECT_NAME = libguac-terminal
|
||||
PROJECT_NUMBER = @PACKAGE_VERSION@
|
||||
|
||||
#
|
||||
# Warn about undocumented parameters and return values, but do not fill output
|
||||
# with verbose progress info.
|
||||
#
|
||||
|
||||
QUIET = YES
|
||||
WARN_NO_PARAMDOC = YES
|
||||
|
||||
#
|
||||
# Output format
|
||||
#
|
||||
|
||||
ALPHABETICAL_INDEX = YES
|
||||
GENERATE_HTML = YES
|
||||
GENERATE_LATEX = NO
|
||||
OPTIMIZE_OUTPUT_FOR_C = YES
|
||||
OUTPUT_DIRECTORY = doxygen-output
|
||||
RECURSIVE = YES
|
||||
SHOW_INCLUDE_FILES = NO
|
||||
|
||||
#
|
||||
# Input format
|
||||
#
|
||||
|
||||
CASE_SENSE_NAMES = YES
|
||||
FILE_PATTERNS = *.h
|
||||
STRIP_FROM_PATH = ../../src/terminal
|
||||
INPUT = ../../src/terminal/terminal/
|
||||
EXCLUDE = ../../src/terminal/terminal/terminal_priv.h
|
||||
JAVADOC_AUTOBRIEF = YES
|
||||
TAB_SIZE = 4
|
||||
TYPEDEF_HIDES_STRUCT = YES
|
||||
|
@ -52,9 +52,9 @@ SHOW_INCLUDE_FILES = NO
|
||||
CASE_SENSE_NAMES = YES
|
||||
EXCLUDE_SYMBOLS = __* guac_palette*
|
||||
FILE_PATTERNS = *.h
|
||||
INPUT = ../src/libguac/guacamole
|
||||
INPUT = ../../src/libguac/guacamole
|
||||
JAVADOC_AUTOBRIEF = YES
|
||||
STRIP_FROM_PATH = ../src/libguac
|
||||
STRIP_FROM_PATH = ../../src/libguac
|
||||
TAB_SIZE = 4
|
||||
TYPEDEF_HIDES_STRUCT = YES
|
||||
|
@ -37,9 +37,9 @@ libguac_terminalinc_HEADERS = \
|
||||
terminal/buffer.h \
|
||||
terminal/char_mappings.h \
|
||||
terminal/common.h \
|
||||
terminal/color-scheme.h \
|
||||
terminal/color_scheme.h \
|
||||
terminal/display.h \
|
||||
terminal/named-colors.h \
|
||||
terminal/named_colors.h \
|
||||
terminal/palette.h \
|
||||
terminal/scrollbar.h \
|
||||
terminal/select.h \
|
||||
@ -52,16 +52,16 @@ libguac_terminalinc_HEADERS = \
|
||||
libguac_terminal_la_SOURCES = \
|
||||
buffer.c \
|
||||
char_mappings.c \
|
||||
color-scheme.c \
|
||||
color_scheme.c \
|
||||
common.c \
|
||||
display.c \
|
||||
named-colors.c \
|
||||
named_colors.c \
|
||||
palette.c \
|
||||
scrollbar.c \
|
||||
select.c \
|
||||
terminal.c \
|
||||
terminal_handlers.c \
|
||||
terminal-stdin-stream.c \
|
||||
terminal_stdin_stream.c \
|
||||
typescript.c \
|
||||
xparsecolor.c
|
||||
|
||||
|
@ -19,7 +19,7 @@
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "terminal/color-scheme.h"
|
||||
#include "terminal/color_scheme.h"
|
||||
#include "terminal/palette.h"
|
||||
#include "terminal/xparsecolor.h"
|
||||
|
@ -22,7 +22,7 @@
|
||||
#include "common/clipboard.h"
|
||||
#include "common/cursor.h"
|
||||
#include "terminal/buffer.h"
|
||||
#include "terminal/color-scheme.h"
|
||||
#include "terminal/color_scheme.h"
|
||||
#include "terminal/common.h"
|
||||
#include "terminal/display.h"
|
||||
#include "terminal/palette.h"
|
||||
|
@ -21,6 +21,13 @@
|
||||
#ifndef _GUAC_TERMINAL_BUFFER_H
|
||||
#define _GUAC_TERMINAL_BUFFER_H
|
||||
|
||||
/**
|
||||
* Data structures and functions related to the terminal buffer.
|
||||
*
|
||||
* @file buffer.h
|
||||
*/
|
||||
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "types.h"
|
||||
|
@ -21,6 +21,12 @@
|
||||
#ifndef _GUAC_TERMINAL_CHAR_MAPPINGS_H
|
||||
#define _GUAC_TERMINAL_CHAR_MAPPINGS_H
|
||||
|
||||
/**
|
||||
* Graphics character mapping definitions.
|
||||
*
|
||||
* @file char_mappings.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
/**
|
||||
|
@ -20,6 +20,12 @@
|
||||
#ifndef GUAC_TERMINAL_COLOR_SCHEME_H
|
||||
#define GUAC_TERMINAL_COLOR_SCHEME_H
|
||||
|
||||
/**
|
||||
* Definitions and functions related to color scheme handling.
|
||||
*
|
||||
* @file color_scheme.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "terminal/palette.h"
|
@ -21,6 +21,12 @@
|
||||
#ifndef _GUAC_TERMINAL_COMMON_H
|
||||
#define _GUAC_TERMINAL_COMMON_H
|
||||
|
||||
/**
|
||||
* Miscellaneous terminal function definitions.
|
||||
*
|
||||
* @file common.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
#include "types.h"
|
||||
|
||||
|
@ -21,6 +21,12 @@
|
||||
#ifndef _GUAC_TERMINAL_DISPLAY_H
|
||||
#define _GUAC_TERMINAL_DISPLAY_H
|
||||
|
||||
/**
|
||||
* Structures and function definitions related to the graphical display.
|
||||
*
|
||||
* @file display.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "common/surface.h"
|
||||
|
@ -20,6 +20,12 @@
|
||||
#ifndef GUAC_TERMINAL_NAMED_COLORS_H
|
||||
#define GUAC_TERMINAL_NAMED_COLORS_H
|
||||
|
||||
/**
|
||||
* Function definitions for operating on individual terminal colors.
|
||||
*
|
||||
* @file named_colors.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
#include "terminal/palette.h"
|
||||
|
@ -20,6 +20,12 @@
|
||||
#ifndef GUAC_TERMINAL_PALETTE_H
|
||||
#define GUAC_TERMINAL_PALETTE_H
|
||||
|
||||
/**
|
||||
* Constants, structures, and function definitions related to the terminal color pallate.
|
||||
*
|
||||
* @file palette.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include <stdint.h>
|
||||
|
@ -20,6 +20,12 @@
|
||||
#ifndef GUAC_TERMINAL_SCROLLBAR_H
|
||||
#define GUAC_TERMINAL_SCROLLBAR_H
|
||||
|
||||
/**
|
||||
* Constants, structures, and function definitions related to the terminal scrollbar.
|
||||
*
|
||||
* @file scrollbar.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include <guacamole/client.h>
|
||||
|
@ -21,6 +21,12 @@
|
||||
#ifndef GUAC_TERMINAL_SELECT_H
|
||||
#define GUAC_TERMINAL_SELECT_H
|
||||
|
||||
/**
|
||||
* Function definitions related to selecting text withing a terminal.
|
||||
*
|
||||
* @file select.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
#include "terminal.h"
|
||||
|
||||
|
@ -21,6 +21,13 @@
|
||||
#ifndef _GUAC_TERMINAL_H
|
||||
#define _GUAC_TERMINAL_H
|
||||
|
||||
/**
|
||||
* Constants, structures, and function definitions defining the core
|
||||
* functionality for the terminal library.
|
||||
*
|
||||
* @file terminal.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "buffer.h"
|
||||
|
@ -21,6 +21,12 @@
|
||||
#ifndef _GUAC_TERMINAL_HANDLERS
|
||||
#define _GUAC_TERMINAL_HANDLERS
|
||||
|
||||
/**
|
||||
* Function definitions for terminal event handlers.
|
||||
*
|
||||
* @file terminal_handlers.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "terminal.h"
|
||||
|
@ -21,6 +21,13 @@
|
||||
#ifndef _GUAC_TERMINAL_TYPES_H
|
||||
#define _GUAC_TERMINAL_TYPES_H
|
||||
|
||||
/**
|
||||
* Structures and function definitions related to individual characters
|
||||
* within the terminal.
|
||||
*
|
||||
* @file types.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
#include "palette.h"
|
||||
|
||||
|
@ -21,6 +21,13 @@
|
||||
#ifndef GUAC_TERMINAL_TYPESCRIPT_H
|
||||
#define GUAC_TERMINAL_TYPESCRIPT_H
|
||||
|
||||
/**
|
||||
* Constants, structures, and function definitions related to terminal
|
||||
* typescripts.
|
||||
*
|
||||
* @file typescript.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include <guacamole/timestamp.h>
|
||||
|
@ -20,6 +20,12 @@
|
||||
#ifndef GUAC_TERMINAL_XPARSECOLOR_H
|
||||
#define GUAC_TERMINAL_XPARSECOLOR_H
|
||||
|
||||
/**
|
||||
* Function definitions related to handling X11 color specs.
|
||||
*
|
||||
* @file xparsecolor.h
|
||||
*/
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "terminal/palette.h"
|
||||
|
@ -19,7 +19,7 @@
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include "terminal/named-colors.h"
|
||||
#include "terminal/named_colors.h"
|
||||
#include "terminal/palette.h"
|
||||
|
||||
#include <stdio.h>
|
||||
|
Loading…
Reference in New Issue
Block a user