diff options
author | Thomas Graf <tgraf@suug.ch> | 2011-07-28 14:23:57 (GMT) |
---|---|---|
committer | Thomas Graf <tgraf@suug.ch> | 2011-07-28 14:23:57 (GMT) |
commit | 70c93717607a15d37b60d7caefb58e78d28c5e59 (patch) | |
tree | 52b991c5cb5fab3f4190015f0a3fd8d8cdf68653 /doc/src | |
parent | 915a23fd16315eed2b13dda38c96ca824935e844 (diff) | |
download | libnl-70c93717607a15d37b60d7caefb58e78d28c5e59.zip libnl-70c93717607a15d37b60d7caefb58e78d28c5e59.tar.gz libnl-70c93717607a15d37b60d7caefb58e78d28c5e59.tar.bz2 |
Updated link documentation
- API documentation
- developer guide
- enabled doxygen navbar
- fixed css
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/hidden.c | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/src/hidden.c b/doc/src/hidden.c new file mode 100644 index 0000000..be4a042 --- /dev/null +++ b/doc/src/hidden.c @@ -0,0 +1,35 @@ +/** + * \cond skip + * vim:syntax=doxygen + * \endcond + +\page auto_ack_warning Disabling Auto-ACK + +\attention Disabling Auto-ACK (nl_socket_disable_auto_ack()) will cause this + function to return immediately after sending the netlink message. + The function will not wait for an eventual error message. It is + the responsibility of the caller to handle any error messages or + ACKs returned. + +\page pointer_lifetime_warning Pointer Lifetime + +\attention The reference counter of the returned object is not incremented. + Therefore, the returned pointer is only valid during the lifetime + of the parent object. Increment the reference counter if the object + is supposed to stay around after the parent object was freed. + +\page private_struct Private Structure + +\note The definition of this structure is private to allow modification + without breaking API. Use the designated accessor functions to + access individual object attributes. + +\page read_only_attribute Read-Only Attribute + +\note The attribute this accessor is modifying is a read-only attribute + which can not be modified in the kernel. Any changes to the + attribute only have an effect on the local copy of the object. The + accessor function is provided solely for the purpose of creating + objects for comparison and filtering. + +*/ |