Skip to content

Commit

Permalink
Misc. documentation edits.
Browse files Browse the repository at this point in the history
  • Loading branch information
hyperrealm committed Oct 27, 2017
1 parent c7d92ab commit 38536fc
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions doc/libconfig.texi
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

@comment %**end of header

@firstparagraphindent insert

@dircategory Software libraries
@direntry
* libconfig: (libconfig). A Library For Processing Structured Configuration Files
Expand Down Expand Up @@ -249,6 +251,7 @@ the "C" locale before reading or writing a configuration.
@comment node-name, next, previous, up
@section Compiling Using pkg-config

@cindex pkg-config
On UNIX systems you can use the @i{pkg-config} utility (version 0.20
or later) to automatically select the appropriate compiler and linker
switches for @i{libconfig}. Ensure that the environment variable
Expand Down Expand Up @@ -384,7 +387,7 @@ application:
pos = @{ x = 350; y = 250; @};
@};
list = ( ( "abc", 123, true ), 1.234, ( /* an empty list */) );
list = ( ( "abc", 123, true ), 1.234, ( /* an empty list */ ) );
books = ( @{ title = "Treasure Island";
author = "Robert Louis Stevenson";
Expand Down Expand Up @@ -1306,6 +1309,7 @@ application-level errors.

@b{Since @i{v1.7}}

@cindex hook
These functions make it possible to attach arbitrary data to a configuration
structure, for instance a ``wrapper'' or ``peer'' object written in
another programming language.
Expand All @@ -1315,6 +1319,7 @@ another programming language.
@deftypefun void config_setting_set_hook (@w{config_setting_t * @var{setting}}, @w{void * @var{hook}})
@deftypefunx {void *} config_setting_get_hook (@w{const config_setting_t * @var{setting}})

@cindex hook
These functions make it possible to attach arbitrary data to each
setting structure, for instance a ``wrapper'' or ``peer'' object written in
another programming language. The destructor function, if one has been
Expand All @@ -1326,6 +1331,7 @@ destroyed. There is no default destructor.

@deftypefun void config_set_destructor (@w{config_t * @var{config}}, @w{void (* @var{destructor})(void *)})

@cindex destructor function
This function assigns the destructor function @var{destructor} for the
configuration @var{config}. This function accepts a single @code{void
*} argument and has no return value. See
Expand Down Expand Up @@ -1404,7 +1410,7 @@ exception @code{SettingException}, which provides the following method:

@deftypemethod SettingException {const char *} getPath () const

Returns the path to the setting associated with the exception, or
This method returns the path to the setting associated with the exception, or
@code{NULL} if there is no applicable path.

@end deftypemethod
Expand Down Expand Up @@ -1477,7 +1483,7 @@ be freed by the caller.
@deftypemethod Config void setIncludeDir (@w{const char *@var{includeDir}})
@deftypemethodx Config {const char *} getIncludeDir () const

@code{setIncludeDir()} specifies the include directory,
The @code{setIncludeDir()} method specifies the include directory,
@var{includeDir}, relative to which the files specified in
@samp{@@include} directives will be located for the configuration. By
default, there is no include directory, and all include files are
Expand Down Expand Up @@ -1893,7 +1899,7 @@ configuration.
@deftypemethod Setting {Setting &} lookup (@w{const char * @var{path}}) const
@deftypemethodx Setting {Setting &} lookup (@w{const std::string &@var{path}}) const

This function locates a setting by a path @var{path} relative to
These methods locate a setting by a path @var{path} relative to
this setting. If requested setting is not found, a
@code{SettingNotFoundException} is thrown.

Expand Down Expand Up @@ -2142,7 +2148,7 @@ integer, or floating point), respectively.

@deftypemethod Setting {const char *} getSourceFile () const

This function returns the name of the file from which the setting was
This method returns the name of the file from which the setting was
read, or NULL if the setting was not read from a file. This
information is useful for reporting application-level errors. Storage
for the returned string is managed by the library and released
Expand All @@ -2153,7 +2159,7 @@ not be freed by the caller.

@deftypemethod Setting {unsigned int} getSourceLine () const

This function returns the line number of the configuration file or
This method returns the line number of the configuration file or
stream at which the setting @var{setting} was read, or 0 if no line
number is available. This information is useful for reporting
application-level errors.
Expand Down Expand Up @@ -2276,11 +2282,15 @@ Heiner Tholen's @i{pylibconfig2} is a Python library that is syntax-compatible
with @i{libconfig}. It may be found at
@url{https://pypi.python.org/pypi/pylibconfig2/0.1.2}.

@sp 1

Christian Aichinger's @i{libconf} is another pure-Python implementation with a
more permissive license. It may be found at
@url{https://pypi.python.org/pypi/libconf} or on github at
@url{https://github.com/Grk0/python-libconf}.

@sp 1

The @i{python-libconfig} wrapper provides Python bindings to @i{libconfig}. It
may be found on github at @url{https://github.com/cnangel/python-libconfig/}.

Expand All @@ -2290,9 +2300,11 @@ may be found on github at @url{https://github.com/cnangel/python-libconfig/}.

Christopher Mark Gore's @i{ruby-libconfig} is a Ruby library that provides Ruby
bindings for @i{libconfig}. It may be found at
@url{https://rubygems.org/gems/libconfig/versions/0.0.1} or on github at
@url{https://rubygems.org/gems/libconfig} or on github at
@url{https://github.com/cgore/ruby-libconfig}.

@sp 1

There is also another Ruby wrapper, @i{libconfig-ruby}, that is included in
the @i{libconfig} git repository at @url{https://github.com/hyperrealm/libconfig},
in the @file{contrib/libconfig-ruby} subdirectory.
Expand Down Expand Up @@ -2383,6 +2395,8 @@ Terminals are defined below as regular expressions:
@code{([-+]?([0-9]*)?\.[0-9]*([eE][-+]?[0-9]+)?)|([-+]([0-9]+)(\.[0-9]*)?[eE][-+]?[0-9]+)}
@end multitable

@sp 1

Note that adjacent strings are automatically concatenated. Non-printable
characters can be represented within strings using a sequence @samp{\xx},
representing the ASCII value as two hex digits.
Expand Down

0 comments on commit 38536fc

Please sign in to comment.