Commit 6f04d7d0 authored by Pekka Pessi's avatar Pekka Pessi

url: updated documentation

darcs-hash:20070919172950-65a35-a615d7ceeb0e83266c8c8bd28424b6c4fb3b422e.gz
parent dabd857a
PROJECT_NAME = "url"
OUTPUT_DIRECTORY = ../docs/html/url
INPUT = @srcdir@/url.docs @srcdir@/sofia-sip @srcdir@ .
INPUT = @srcdir@/url.docs @srcdir@/sofia-sip/url.h @srcdir@/url.c
INPUT += @srcdir@/url_tag.c
@INCLUDE_PATH = . @srcdir@
@INCLUDE = ../docs/Doxyfile.conf
......
......@@ -17,7 +17,7 @@ INCLUDES = -I$(srcdir)/../bnf -I../bnf \
noinst_LTLIBRARIES = liburl.la
check_PROGRAMS = torture_url test_urlmap
check_PROGRAMS = torture_url
# ----------------------------------------------------------------------
# Rules for building the targets
......@@ -37,14 +37,18 @@ LDADD = liburl.la \
../ipt/libipt.la \
../su/libsu.la
test_urlmap_SOURCES = urlmap.c urlmap.h
test_urlmap_CFLAGS = $(CFLAGS) -DTEST_URLMAP=1
# ----------------------------------------------------------------------
# Install and distribution rules
EXTRA_DIST = url.docs $(BUILT_SOURCES)
# ----------------------------------------------------------------------
# urlmap is not used
#check_PROGRAMS += test_urlmap
#test_urlmap_SOURCES = urlmap.c urlmap.h
#test_urlmap_CFLAGS = $(CFLAGS) -DTEST_URLMAP=1
EXTRA_DIST += urlmap.c urlmap.h
# ----------------------------------------------------------------------
# Tests
......
......@@ -20,8 +20,7 @@ structure.
@note
Please note that we use terms URL and URI interchangeable.
The formal URI syntax is defined in the
<a href="http://www.ietf.org/rfc/rfc2396.txt">RFC2396</a>.
The formal URI syntax is defined in the @RFC3986.
The URLs consist of a subset of printable ASCII (ECMA-5) characters. The
subset excludes space and characters commonly used as @e delimiters in
......@@ -51,7 +50,7 @@ and @b pres: URLs:
<i>host</i> [":" <i>port</i> ] ] [";" <i>params</i> ] ["?" <i>query</i> ]
["#" <i>fragment</i> ]
Note that also "*" is considered to be a valid URL (with type #url_any).
Note that url parser also considers "*" to be a valid URL (with type #url_any).
For example: \n
@code
......@@ -103,7 +102,7 @@ newly allocated string.
@subsection url_reference Functions and Macros in URL Module
The include file <url.h> contains the types, function and macros of URL
The include file <sofia-sip/url.h> contains the types, function and macros of URL
module. The functions and macros are listed here for the reference, too.
The most important functions and macros for manipulating URLs are here:
@code
......@@ -123,7 +122,6 @@ int url_cmp_all(url_t const *a, url_t const *b);
isize_t url_param(char const *params, char const *tag,
char value[], isize_t vlen);
int url_has_param(url_t const *url, char const *name);
isize_t url_have_param(char const *params, char const *tag);
int url_param_add(su_home_t *h, url_t *url, char const *param);
@endcode
......
......@@ -126,6 +126,8 @@ int urltag_scan(tag_type_t tt, su_home_t *home,
url_t *url;
char *s;
(void)tt;
for (len = 0; !IS_EXCLUDED(str[len]); len++)
;
......
......@@ -22,7 +22,7 @@
*
*/
/**
/**@internal
* @file urlmap.c
* @brief Mapping with hierarchical URLs.
*
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment