diff --git a/dcapi/doc/Makefile.am b/dcapi/doc/Makefile.am index 45998ae003..ba7c355d47 100644 --- a/dcapi/doc/Makefile.am +++ b/dcapi/doc/Makefile.am @@ -37,6 +37,7 @@ EXTRA_DIST = \ $(HTML_IMAGES) \ $(DOC_MAIN_SGML_FILE) +CONTENT_STAMPS = client/sgml.stamp master/sgml.stamp common/sgml.stamp DOC_STAMPS = html-build.stamp $(srcdir)/html.stamp CLEANFILES = $(DOC_STAMPS) @@ -44,7 +45,7 @@ CLEANFILES = $(DOC_STAMPS) if ENABLE_GTK_DOC all-local: html-build.stamp -html-build.stamp: $(DOC_MAIN_SGML_FILE) $(content_files) +html-build.stamp: $(DOC_MAIN_SGML_FILE) $(content_files) $(CONTENT_STAMPS) @echo 'gtk-doc: Building HTML' @-chmod -R u+w $(srcdir) rm -rf $(srcdir)/html diff --git a/dcapi/doc/common/dc-common-sections.txt b/dcapi/doc/common/dc-common-sections.txt index bb5fa4e546..680bd7df5e 100644 --- a/dcapi/doc/common/dc-common-sections.txt +++ b/dcapi/doc/common/dc-common-sections.txt @@ -8,6 +8,7 @@ DC_GridCapabilities DC_FileMode DC_CONFIG_FILE DC_getCfgStr +DC_getCfgInt DC_log DC_vlog diff --git a/dcapi/doc/common/tmpl/dc_common.sgml b/dcapi/doc/common/tmpl/dc_common.sgml index 301c82465c..f2b48a05f0 100644 --- a/dcapi/doc/common/tmpl/dc_common.sgml +++ b/dcapi/doc/common/tmpl/dc_common.sgml @@ -73,7 +73,22 @@ Returns the value belonging to the specified key @name in the configuration file @name: the key to look up. -@Returns: the value belonging to the key or %NULL if it is not defined in the config file. +@Returns: the value belonging to the key or %NULL if it is not defined in the + config file. The returned value must be deallocated using free() when it is + no longer needed. + + + + +Returns the integer value belonging to the specified key @name in the configuration +file. Unit suffixes like 'KB', 'GB' or 'hour' are also allowed. + + +@name: the key to look up. +@defaultValue: the default value to return if the key is not defined or its value + cannot be interpreted as a number. +@Returns: the value belonging to the key or @defaultValue if it is not defined in the + config file. diff --git a/dcapi/doc/master/dc-master-sections.txt b/dcapi/doc/master/dc-master-sections.txt index 8f8662c78d..a9dfc0ee9b 100644 --- a/dcapi/doc/master/dc-master-sections.txt +++ b/dcapi/doc/master/dc-master-sections.txt @@ -44,6 +44,10 @@ DC_resumeWU DC_destroyWU DC_sendWUMessage + +DC_getClientCfgStr +DC_getClientCfgInt + DC_getResultCapabilities DC_getResultWU diff --git a/dcapi/doc/master/tmpl/dc.sgml b/dcapi/doc/master/tmpl/dc.sgml index 8142e221b6..55cccfdf5a 100644 --- a/dcapi/doc/master/tmpl/dc.sgml +++ b/dcapi/doc/master/tmpl/dc.sgml @@ -443,6 +443,38 @@ be determined with the DC_getMaxMessageSize() function. @Returns: 0 if successful or a #DC_ErrorCode. + + +Returns the value belonging to the specified key @key for the specific client +application @clientName in the configuration file. + + +@clientName: the name of the client application. +@key: the key to look up. +@fallbackGlobal: if %TRUE and the key is not defined in the client configuration, + it will be looked up in the master configuration as well. +@Returns: the value belonging to the key or %NULL if it is not defined in the + config file. The returned value must be deallocated using free() when it is + no longer needed. + + + + +Returns the integer value belonging to the specified key @key for the +specific client application @clientName in the configuration +file. Unit suffixes like 'KB', 'GB' or 'hour' are also allowed. + + +@clientName: the name of the client application. +@key: the key to look up. +@defaultValue: the default value to return if the key is not defined or its value + cannot be interpreted as a number. +@fallbackGlobal: if %TRUE and the key is not defined in the client configuration, + it will be looked up in the master configuration as well. +@Returns: the value belonging to the key or @defaultValue if it is not defined in the + config file. + + Determines what kind of information is present in the received result.