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 /lib/object.c | |
| 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 'lib/object.c')
| -rw-r--r-- | lib/object.c | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/lib/object.c b/lib/object.c index 554d09b..7606535 100644 --- a/lib/object.c +++ b/lib/object.c @@ -10,9 +10,21 @@ */ /** - * @ingroup cache - * @defgroup object Object + * @ingroup core_types + * @defgroup object Object (Cacheable) + * + * Generic object data type, for inheritance purposes to implement cacheable + * data types. + * + * Related sections in the development guide: + * * @{ + * + * Header + * ------ + * ~~~~{.c} + * #include <netlink/object.h> + * ~~~~ */ #include <netlink-local.h> |