diff options
| author | Thomas Graf <tgraf@redhat.com> | 2012-05-10 10:03:59 (GMT) |
|---|---|---|
| committer | Thomas Graf <tgraf@redhat.com> | 2012-05-10 10:03:59 (GMT) |
| commit | fec10a282355def49133e63b8a4591cc51b46478 (patch) | |
| tree | 68995f7b253397edfe7ba0511c14a9b1bf85a911 /doc/core.txt | |
| parent | 32057bc15469e6f012841605daa38766497fa196 (diff) | |
| download | libnl-fec10a282355def49133e63b8a4591cc51b46478.zip libnl-fec10a282355def49133e63b8a4591cc51b46478.tar.gz libnl-fec10a282355def49133e63b8a4591cc51b46478.tar.bz2 | |
doc: documentation restructuring
- changes the modules hierarchy to better represent the set of libaries
- list the header file that needs to be included
- remove examples/doc from api ref that is included in the guide
- add references to the guide
- fix doxygen api linking for version 1.8.0
- readd doxygen mainpage to config file
- fix a couple of doxygen doc bugs
Diffstat (limited to 'doc/core.txt')
| -rw-r--r-- | doc/core.txt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/core.txt b/doc/core.txt index 7f26e05..8a26dba 100644 --- a/doc/core.txt +++ b/doc/core.txt @@ -2811,6 +2811,17 @@ is stored in +*result+. NOTE: Make sure to return the reference to an address using `nl_addr_put()` after usage to allow memory being freed. +.Example: Transform character string to abstract address +[source,c] +----- +struct nl_addr *a = nl_addr_parse("::1", AF_UNSPEC); +printf("Address family: %s\n", nl_af2str(nl_addr_get_family(a))); +nl_addr_put(a); +a = nl_addr_parse("11:22:33:44:55:66", AF_UNSPEC); +printf("Address family: %s\n", nl_af2str(nl_addr_get_family(a))); +nl_addr_put(a); +----- + .Address References Abstract addresses use reference counting to account for all users of |