From 44b54704433753599ff246e4461556afef645a5d Mon Sep 17 00:00:00 2001 From: Aris Adamantiadis Date: Mon, 6 Nov 2006 22:58:58 +0000 Subject: at least I get a working doxygen documentation. I am going to make the whole documentation as doxygen files. git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@77 7dcaeef0-15fb-0310-b436-a5af3365683c --- Doxyfile | 63 +++++++++++-------------------------------------- include/libssh/libssh.h | 2 ++ include/libssh/priv.h | 3 ++- libssh/options.c | 21 ++++++++++++++++- 4 files changed, 38 insertions(+), 51 deletions(-) diff --git a/Doxyfile b/Doxyfile index f101a305..52a5b5ce 100644 --- a/Doxyfile +++ b/Doxyfile @@ -5,7 +5,7 @@ #--------------------------------------------------------------------------- PROJECT_NAME = libssh PROJECT_NUMBER = 0.2-dev -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = /home/aris/dev/libssh/trunk/doxygen/ CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English USE_WINDOWS_ENCODING = NO @@ -46,7 +46,7 @@ SUBGROUPING = YES EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO -EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO HIDE_UNDOC_MEMBERS = YES HIDE_UNDOC_CLASSES = YES @@ -58,7 +58,7 @@ HIDE_SCOPE_NAMES = NO SHOW_INCLUDE_FILES = YES INLINE_INFO = YES SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO +SORT_BRIEF_DOCS = YES SORT_BY_SCOPE_NAME = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES @@ -72,7 +72,7 @@ FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -QUIET = NO +QUIET = YES WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES @@ -82,48 +82,13 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = /home/aris/dev/libssh/trunk +INPUT = /home/aris/dev/libssh/trunk/include/ \ + /home/aris/dev/libssh/trunk/libssh/ FILE_PATTERNS = *.c \ *.cc \ - *.cxx \ *.cpp \ - *.c++ \ - *.d \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.idl \ - *.odl \ - *.cs \ - *.php \ - *.php3 \ - *.inc \ - *.m \ - *.mm \ - *.dox \ - *.py \ - *.C \ - *.CC \ - *.C++ \ - *.II \ - *.I++ \ - *.H \ - *.HH \ - *.H++ \ - *.CS \ - *.PHP \ - *.PHP3 \ - *.M \ - *.MM \ - *.PY + *.dox RECURSIVE = YES EXCLUDE = EXCLUDE_SYMLINKS = NO @@ -138,7 +103,7 @@ FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- -SOURCE_BROWSER = YES +SOURCE_BROWSER = NO INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES REFERENCED_BY_RELATION = YES @@ -149,7 +114,7 @@ VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO +ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = #--------------------------------------------------------------------------- @@ -175,7 +140,7 @@ TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -GENERATE_LATEX = YES +GENERATE_LATEX = NO LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex @@ -199,7 +164,7 @@ RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -GENERATE_MAN = NO +GENERATE_MAN = YES MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = NO @@ -245,9 +210,9 @@ PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES +CLASS_DIAGRAMS = NO HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = YES +HAVE_DOT = NO CLASS_GRAPH = YES COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES @@ -255,7 +220,7 @@ UML_LOOK = NO TEMPLATE_RELATIONS = NO INCLUDE_GRAPH = YES INCLUDED_BY_GRAPH = YES -CALL_GRAPH = YES +CALL_GRAPH = NO CALLER_GRAPH = NO GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES diff --git a/include/libssh/libssh.h b/include/libssh/libssh.h index 60002504..2221386b 100644 --- a/include/libssh/libssh.h +++ b/include/libssh/libssh.h @@ -220,6 +220,8 @@ void ssh_options_set_rsa_server_key(SSH_OPTIONS *opt, char *rsakey); /* buffer.c */ +/** creates a new buffer + */ BUFFER *buffer_new(); void buffer_free(BUFFER *buffer); /* buffer_get returns a pointer to the begining of the buffer. no position is taken into account */ diff --git a/include/libssh/priv.h b/include/libssh/priv.h index 1dd6e92f..7fbf238e 100644 --- a/include/libssh/priv.h +++ b/include/libssh/priv.h @@ -150,7 +150,8 @@ struct string_struct { unsigned char string[MAX_PACKET_LEN]; } __attribute__ ((packed)); - +/** Describes a buffer state at a moment + */ struct buffer_struct { char *data; int used; diff --git a/libssh/options.c b/libssh/options.c index 813e3ad3..53a62854 100644 --- a/libssh/options.c +++ b/libssh/options.c @@ -27,7 +27,22 @@ MA 02111-1307, USA. */ #include #include "libssh/priv.h" -/* by default, ssh1 support is not allowed */ +/** defgroup ssh_options + * \brief options settings for a new ssh session + */ +/** \addtogroup ssh_options + * @{ */ + +/** This structure is freed automaticaly by ssh_disconnect() + * when you use it. \n + * It can be used by only one ssh_connect(), not more.\n + * also by default, ssh1 support is not allowed + * + * \brief initializes a new option structure + * \returns an empty intialized option structure. + * \see ssh_getopt() +*/ + SSH_OPTIONS *ssh_options_new(){ SSH_OPTIONS *option=malloc(sizeof(SSH_OPTIONS)); memset(option,0,sizeof(SSH_OPTIONS)); @@ -401,3 +416,7 @@ int ssh_options_getopt(SSH_OPTIONS *options, int *argcptr, char **argv){ } else return 0 ; } + + + +/** @} */ -- cgit v1.2.3