aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2006-11-06 20:44:24 +0000
committerAris Adamantiadis <aris@0xbadc0de.be>2006-11-06 20:44:24 +0000
commitea215fdecc62cc3ca25f707dade07941d66f7856 (patch)
treedf2ef4bd99f6b871b36f0947167d45b03c7bae56
parentb2d0d13a2d6709c740453ee3ff32bc37160cc331 (diff)
downloadlibssh-ea215fdecc62cc3ca25f707dade07941d66f7856.tar.gz
libssh-ea215fdecc62cc3ca25f707dade07941d66f7856.tar.xz
libssh-ea215fdecc62cc3ca25f707dade07941d66f7856.zip
Added doxygen documentation file. Now need to document it..
added const keyword into ssh_connect_host git-svn-id: svn+ssh://svn.berlios.de/svnroot/repos/libssh/trunk@76 7dcaeef0-15fb-0310-b436-a5af3365683c
-rw-r--r--Doxyfile55
-rw-r--r--libssh/connect.c2
2 files changed, 33 insertions, 24 deletions
diff --git a/Doxyfile b/Doxyfile
index 8fa78bb0..f101a305 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -1,10 +1,10 @@
-# Doxyfile 1.3.7-KDevelop
+# Doxyfile 1.4.7
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
-PROJECT_NAME = libssh.kdevelop
-PROJECT_NUMBER = $VERSION$
+PROJECT_NAME = libssh
+PROJECT_NUMBER = 0.2-dev
OUTPUT_DIRECTORY =
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
@@ -25,18 +25,20 @@ ABBREVIATE_BRIEF = "The $name class" \
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
-STRIP_FROM_PATH = /home/aris/dev/libssh-0.2-dev/svn/trunk/
+STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
-DISTRIBUTE_GROUP_DOC = NO
+SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
ALIASES =
-OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
+BUILTIN_STL_SUPPORT = NO
+DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
#---------------------------------------------------------------------------
# Build related configuration options
@@ -46,8 +48,8 @@ EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
-HIDE_UNDOC_MEMBERS = NO
-HIDE_UNDOC_CLASSES = NO
+HIDE_UNDOC_MEMBERS = YES
+HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
@@ -65,6 +67,8 @@ GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
+SHOW_DIRECTORIES = NO
+FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
@@ -72,17 +76,19 @@ QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
-INPUT = /home/aris/dev/libssh-0.2-dev/svn/trunk
+INPUT = /home/aris/dev/libssh/trunk
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
+ *.d \
*.java \
*.ii \
*.ixx \
@@ -102,6 +108,8 @@ FILE_PATTERNS = *.c \
*.inc \
*.m \
*.mm \
+ *.dox \
+ *.py \
*.C \
*.CC \
*.C++ \
@@ -115,15 +123,8 @@ FILE_PATTERNS = *.c \
*.PHP3 \
*.M \
*.MM \
- *.C \
- *.H \
- *.tlh \
- *.diff \
- *.patch \
- *.moc \
- *.xpm \
- *.dox
-RECURSIVE = yes
+ *.PY
+RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
@@ -132,15 +133,18 @@ EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
+FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
-SOURCE_BROWSER = NO
+SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
+REFERENCES_LINK_SOURCE = YES
+USE_HTAGS = NO
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
@@ -202,7 +206,7 @@ MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
-GENERATE_XML = yes
+GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
@@ -234,7 +238,7 @@ SKIP_FUNCTION_MACROS = YES
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
-GENERATE_TAGFILE = libssh.tag
+GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
@@ -243,21 +247,26 @@ PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
HIDE_UNDOC_RELATIONS = YES
-HAVE_DOT = NO
+HAVE_DOT = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
+GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
-CALL_GRAPH = NO
+CALL_GRAPH = YES
+CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
+DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1024
MAX_DOT_GRAPH_DEPTH = 1000
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
diff --git a/libssh/connect.c b/libssh/connect.c
index 73e956a6..fefda87c 100644
--- a/libssh/connect.c
+++ b/libssh/connect.c
@@ -63,7 +63,7 @@ static int getai(const char *host, int port, struct addrinfo **ai)
return getaddrinfo(host,service,&hints,ai);
}
-int ssh_connect_ai_timeout(SSH_SESSION *session, char *host, int port, struct addrinfo *ai,
+int ssh_connect_ai_timeout(SSH_SESSION *session, const char *host, int port, struct addrinfo *ai,
long timeout, long usec,int s)
{
struct timeval to;