Rooba
/
boinc
mirror of https://github.com/BOINC/boinc.git
1
0
Fork 0
Code Issues 1 Packages Projects Releases Wiki Activity

Documentation updates 

git-svn-id: svn+ssh://cvs.lpds.sztaki.hu/var/lib/svn/szdg/dcapi/trunk@486 a7169a2c-3604-0410-bc95-c702d8d87f7a
This commit is contained in:
gombasg 2006-04-27 15:46:39 +00:00 committed by Adam Visegradi
parent f15ecb6d62
commit 84480569ad
5 changed files with 55 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
dcapi/doc/Makefile.am
View File

@ -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

1
dcapi/doc/common/dc-common-sections.txt
View File

@ -8,6 +8,7 @@ DC_GridCapabilities
DC_FileMode
DC_CONFIG_FILE
DC_getCfgStr
DC_getCfgInt
DC_log
DC_vlog

17
dcapi/doc/common/tmpl/dc_common.sgml
View File

@ -73,7 +73,22 @@ Returns the value belonging to the specified key @name in the configuration file
</para>
@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.
<!-- ##### FUNCTION DC_getCfgInt ##### -->
<para>
Returns the integer value belonging to the specified key @name in the configuration
file. Unit suffixes like 'KB', 'GB' or 'hour' are also allowed.
</para>
@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.
<!-- ##### FUNCTION DC_log ##### -->

4
dcapi/doc/master/dc-master-sections.txt
View File

@ -44,6 +44,10 @@ DC_resumeWU
DC_destroyWU
DC_sendWUMessage
<SUBSECTION>
DC_getClientCfgStr
DC_getClientCfgInt
<SUBSECTION>
DC_getResultCapabilities
DC_getResultWU

32
dcapi/doc/master/tmpl/dc.sgml
View File

@ -443,6 +443,38 @@ be determined with the DC_getMaxMessageSize() function.
@Returns: 0 if successful or a #DC_ErrorCode.
<!-- ##### FUNCTION DC_getClientCfgStr ##### -->
<para>
Returns the value belonging to the specified key @key for the specific client
application @clientName in the configuration file.
</para>
@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.
<!-- ##### FUNCTION DC_getClientCfgInt ##### -->
<para>
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.
</para>
@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.
<!-- ##### FUNCTION DC_getResultCapabilities ##### -->
<para>
Determines what kind of information is present in the received result.